Merge pull request #20 from mxenabled/bm/beta_release

Prepare for Beta release

Author: brettmortensen

README.md

@@ -37,47 +37,23 @@ In order to make API requests, you will need to [sign up for the MX Platform API
 end
 ```
 
-## List endpoints
+## Paginated endpoints
 
-The simplest way to read back all objects from the list endpoints is through the "_each" methods. These methods yield one object at a time.
+For paginated endpoints, the pagination values can be accessed through the returned `::MXPlatformRuby::Page` array as follows
 
 ```ruby
-::MXPlatformRuby::Institution.list_institutions_each do |institution|
-  p institution
-end
-```
-
-#### Additional control
-
-For additional control when working with the `page` and `records_per_page` parameters, we've also surfaced "pagination" endpoints.
+institutions = ::MXPlatformRuby::Institution.list_institutions(options)
 
-To retrieve a single page,
-```ruby
-page = ::MXPlatformRuby::Institution.list_institutions_page(page: 1, records_per_page: 10)
-
-puts page.current_page
-puts page.per_page
-puts page.total_entries
-puts page.total_pages
+puts "Current page: #{institutions.current_page}"
+puts "Per page: #{institutions.per_page}"
+puts "Total entries: #{institutions.total_entries}"
+puts "Total pages: #{institutions.total_pages}"
 
-page.each do |institution|
+institutions.each do |institution|
   p institution
 end
 ```
 
-To retrieve multiple pages,
-```ruby
-::MXPlatformRuby::Institution.list_institutions_pages_each(page: 1, records_per_page: 10) do |page|
-  puts page.current_page
-  puts page.per_page
-  puts page.total_entries
-  puts page.total_pages
-
-  page.each do |institution|
-    p institution
-  end
-end
-```
 
 ## Contributing
 

lib/mx-platform-ruby/account.rb

@@ -46,24 +46,12 @@ class Account
     attribute :updated_at
     attribute :user_guid
 
-    def self.list_user_accounts_page(options = {})
+    def self.list_user_accounts(options = {})
       options = list_user_accounts_options(options)
 
       paginate(options)
     end
 
-    def self.list_user_accounts_each(options = {}, &block)
-      options = list_user_accounts_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_user_accounts_pages_each(options = {}, &block)
-      options = list_user_accounts_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     def self.read_account(options = {})
       read_account_options = read_account_options(options)
       response = ::MXPlatformRuby.client.make_request(read_account_options)

lib/mx-platform-ruby/account_number.rb

@@ -14,42 +14,18 @@ class AccountNumber
     attribute :transit_number
     attribute :user_guid
 
-    def self.list_account_numbers_by_account_page(options = {})
+    def self.list_account_numbers_by_account(options = {})
       options = list_account_numbers_by_account_options(options)
 
       paginate(options)
     end
 
-    def self.list_account_numbers_by_account_each(options = {}, &block)
-      options = list_account_numbers_by_account_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_account_numbers_by_account_pages_each(options = {}, &block)
-      options = list_account_numbers_by_account_options(options)
-
-      paginate_pages(options, &block)
-    end
-
-    def self.list_account_numbers_by_member_page(options = {})
+    def self.list_account_numbers_by_member(options = {})
       options = list_account_numbers_by_member_options(options)
 
       paginate(options)
     end
 
-    def self.list_account_numbers_by_member_each(options = {}, &block)
-      options = list_account_numbers_by_member_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_account_numbers_by_member_pages_each(options = {}, &block)
-      options = list_account_numbers_by_member_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     # Private class methods
 
     def self.list_account_numbers_by_account_options(options)

lib/mx-platform-ruby/account_owner.rb

@@ -18,24 +18,12 @@ class AccountOwner
     attribute :state
     attribute :user_guid
 
-    def self.list_account_owners_page(options = {})
+    def self.list_account_owners(options = {})
       options = list_account_owners_options(options)
 
       paginate(options)
     end
 
-    def self.list_account_owners_each(options = {}, &block)
-      options = list_account_owners_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_account_owners_pages_each(options = {}, &block)
-      options = list_account_owners_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     # Private class methods
 
     def self.list_account_owners_options(options)

lib/mx-platform-ruby/category.rb

@@ -27,42 +27,18 @@ def self.delete_category(options = {})
       ::MXPlatformRuby.client.make_request(delete_category_options)
     end
 
-    def self.list_categories_page(options = {})
+    def self.list_categories(options = {})
       options = list_categories_options(options)
 
       paginate(options)
     end
 
-    def self.list_categories_each(options = {}, &block)
-      options = list_categories_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_categories_pages_each(options = {}, &block)
-      options = list_categories_options(options)
-
-      paginate_pages(options, &block)
-    end
-
-    def self.list_default_categories_page(options = {})
+    def self.list_default_categories(options = {})
       options = list_default_categories_options(options)
 
       paginate(options)
     end
 
-    def self.list_default_categories_each(options = {}, &block)
-      options = list_default_categories_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_default_categories_pages_each(options = {}, &block)
-      options = list_default_categories_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     def self.read_category(options = {})
       read_category_options = read_category_options(options)
       response = ::MXPlatformRuby.client.make_request(read_category_options)

lib/mx-platform-ruby/challenge.rb

@@ -13,24 +13,12 @@ class Challenge
     attribute :options
     attribute :type
 
-    def self.list_member_challenges_page(options = {})
+    def self.list_member_challenges(options = {})
       options = list_member_challenges_options(options)
 
       paginate(options)
     end
 
-    def self.list_member_challenges_each(options = {}, &block)
-      options = list_member_challenges_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_member_challenges_pages_each(options = {}, &block)
-      options = list_member_challenges_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     # Private class methods
 
     def self.list_member_challenges_options(options)

lib/mx-platform-ruby/client.rb

@@ -32,9 +32,9 @@ def make_request(options = {})
 
     def default_headers
       {
-        'Accept' => 'application/vnd.mx.api.v1+json',
-        'Authorization' => "Basic #{::Base64.urlsafe_encode64("#{username}:#{password}")}",
-        'Content-Type' => 'application/json'
+        'Accept': 'application/vnd.mx.api.v1+json',
+        'Authorization': "Basic #{::Base64.urlsafe_encode64("#{username}:#{password}")}",
+        'Content-Type': 'application/json'
       }
     end
 

lib/mx-platform-ruby/credential.rb

@@ -11,42 +11,18 @@ class Credential
     attribute :guid
     attribute :label
 
-    def self.list_institution_required_credentials_page(options = {})
+    def self.list_institution_required_credentials(options = {})
       options = list_institution_required_credentials_options(options)
 
       paginate(options)
     end
 
-    def self.list_institution_required_credentials_each(options = {}, &block)
-      options = list_institution_required_credentials_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_institution_required_credentials_pages_each(options = {}, &block)
-      options = list_institution_required_credentials_options(options)
-
-      paginate_pages(options, &block)
-    end
-
-    def self.list_member_credentials_page(options = {})
+    def self.list_member_credentials(options = {})
       options = list_member_credentials_options(options)
 
       paginate(options)
     end
 
-    def self.list_member_credentials_each(options = {}, &block)
-      options = list_member_credentials_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_member_credentials_pages_each(options = {}, &block)
-      options = list_member_credentials_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     # Private class methods
 
     def self.list_institution_required_credentials_options(options)

lib/mx-platform-ruby/holding.rb

@@ -24,42 +24,18 @@ class Holding
     attribute :updated_at
     attribute :user_guid
 
-    def self.list_holdings_by_member_page(options = {})
+    def self.list_holdings_by_member(options = {})
       options = list_holdings_by_member_options(options)
 
       paginate(options)
     end
 
-    def self.list_holdings_by_member_each(options = {}, &block)
-      options = list_holdings_by_member_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_holdings_by_member_pages_each(options = {}, &block)
-      options = list_holdings_by_member_options(options)
-
-      paginate_pages(options, &block)
-    end
-
-    def self.list_holdings_by_user_page(options = {})
+    def self.list_holdings_by_user(options = {})
       options = list_holdings_by_user_options(options)
 
       paginate(options)
     end
 
-    def self.list_holdings_by_user_each(options = {}, &block)
-      options = list_holdings_by_user_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_holdings_by_user_pages_each(options = {}, &block)
-      options = list_holdings_by_user_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     def self.read_holding(options = {})
       read_holding_options = read_holding_options(options)
       response = ::MXPlatformRuby.client.make_request(read_holding_options)

lib/mx-platform-ruby/institution.rb

@@ -16,42 +16,18 @@ class Institution
     attribute :supports_transaction_history
     attribute :url
 
-    def self.list_favorites_page(options = {})
+    def self.list_favorites(options = {})
       options = list_favorites_options(options)
 
       paginate(options)
     end
 
-    def self.list_favorites_each(options = {}, &block)
-      options = list_favorites_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_favorites_pages_each(options = {}, &block)
-      options = list_favorites_options(options)
-
-      paginate_pages(options, &block)
-    end
-
-    def self.list_institutions_page(options = {})
+    def self.list_institutions(options = {})
       options = list_institutions_options(options)
 
       paginate(options)
     end
 
-    def self.list_institutions_each(options = {}, &block)
-      options = list_institutions_options(options)
-
-      paginate_each(options, &block)
-    end
-
-    def self.list_institutions_pages_each(options = {}, &block)
-      options = list_institutions_options(options)
-
-      paginate_pages(options, &block)
-    end
-
     def self.read_institution(options = {})
       read_institution_options = read_institution_options(options)
       response = ::MXPlatformRuby.client.make_request(read_institution_options)