bank_exchange_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2829bbc1fdddd9b6dca0279223786e8d608ff722
-  data.tar.gz: f0da7b52da3ee20fba8c00147fb6ae737d5d63f0
+  metadata.gz: ddbe43ca58c823d4d48a69fa48a4110fe92aa742
+  data.tar.gz: 45fcb1be71365bb05dd71e4f4db62615a0c7ff38
 SHA512:
-  metadata.gz: 75004c2f7ecc4d768f96e71382059f4e784276fdc26b1121c569798698861cef4500ca5d6128e221e29d851af01b1dc614fae128ec3261236fc0f7e9fcde13ef
-  data.tar.gz: 2887f461fb642f7ff34e0dd0773a4e76024a28dca7e35ffd686de60dc7191e932b3fabb331f7e514ee24b0ad02c3c721147a2af5df056d7b6177d30bb862eb7a
+  metadata.gz: 49f85a0d17821e66ece907e32ea9c17f55ede337b8c28a8f346ca115588b21b6aa7d7d76e9db5038e950ba06d6dcc75ee41f09fbe8345095da318403312ddbb1
+  data.tar.gz: 22d2a030ad788101ce06fa2eb4687c4f45c8b24f18e899f587d8d9e63d5375d4d38ee44cdb26b1c545bd6aaf3d4bedeaef781dcef5e4bb3180bf8a805f353501

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.1
+
+* REMOVALS
+    * Outdated param `countries` was renamed to `iso_to` in `@cli.bank`
+* BUG FIXES
+    * Fix `instance variable is not initialized` warning
+* ENHANCEMENTS
+    * Add pagination to some endpoints. Example: `@cli.rates{ |response| puts response.data }`

data/README.md

@@ -2,10 +2,16 @@
 
 [![Build Status](https://semaphoreci.com/api/v1/shlima/bank_exchange_ruby_api/branches/master/badge.svg)](https://semaphoreci.com/shlima/bank_exchange_ruby_api) [![Code Climate](https://codeclimate.com/github/BankExchange/bank_exchange_ruby_api/badges/gpa.svg)](https://codeclimate.com/github/BankExchange/bank_exchange_ruby_api) [![Dependency Status](https://gemnasium.com/BankExchange/bank_exchange_ruby_api.svg)](https://gemnasium.com/BankExchange/bank_exchange_ruby_api)
 
-> STATUS: WIP
+## RUBY EXCHANGE RATES API
 
 This is the Ruby API client for the BankExchange service. Please read the official documentation to get further information http://bank.exchange/documentation
 
+## Installation
+
+```bash
+  gem install bank_exchange_api
+```
+
 ## Configuration
 
 ```ruby
@@ -28,7 +34,22 @@ This is the Ruby API client for the BankExchange service. Please read the offici
   @cli.ping #=> true
 ```
 
-## Banks list [response methods overview]
+## Response methods 
+```
+  request = @cli.banks(countries: ['US']) 
+  response = request.json
+  
+  response.data             # root-data of the endpoint  
+  response.body             # whole response data
+  reponse.params            # request params in response
+  response.pagination       # pagination params
+  response.next_page_url    # next page URL if resource is paginatable
+  response.paginatable?     # if resource is paginatable and next page exists
+  response.not_paginatable?
+  response.success?         #=> true if response status code is 2xx
+```
+
+## Banks list 
 
 ```ruby
   # @option countries [Array]
@@ -39,10 +60,6 @@ This is the Ruby API client for the BankExchange service. Please read the offici
   response = request.json
 ```
 
-```ruby
-  response.success? #=> true
-```
-
 ```ruby
   # @return [Hash]
   response.params
@@ -65,15 +82,15 @@ This is the Ruby API client for the BankExchange service. Please read the offici
 
 ```ruby
   # @param swift [String]
-  # @option currencies [Array]
+  # @option iso_to [Array]
   # @option date [Date,String]
   # @option fallback_days [Integer]
-  response = @cli.bank("XXXXXXXX", date: Date.today, currencies: ['EUR']).json
+  response = @cli.bank("XXXXXXXX", date: Date.today, iso_to: ['EUR']).json
 ```
 
 ```ruby  
   response.params
-  {"swift"=>"XXXXXXXX", "currencies"=>["EUR"], "date"=>"2016-03-22", "fallback_days"=>5}  
+  {"swift"=>"XXXXXXXX", "iso_to"=>["EUR"], "date"=>"2016-03-22", "fallback_days"=>5}  
 ```
 
 ```ruby  
@@ -83,7 +100,19 @@ This is the Ruby API client for the BankExchange service. Please read the offici
 
 ```ruby  
   response.body
-  {"params"=>{"swift"=>"XXXXXXXX", "currencies"=>["EUR"], "date"=>"2016-03-22", "fallback_days"=>4}, "bank"=>{"swift"=>"XXXXXXXX", "name"=>"Board of Governors of the Federal Reserve System", "country"=>"US", "currency"=>"USD", "website"=>"http://www.federalreserve.gov"}, "rates"=>[{"iso_from"=>"USD", "iso_to"=>"EUR", "rate"=>0.885582713425434, "inverse_rate"=>1.1292, "date"=>"2016-03-18"}]}    
+  {"params"=>{"swift"=>"XXXXXXXX", "iso_to"=>["EUR"], "date"=>"2016-03-22", "fallback_days"=>4}, "bank"=>{"swift"=>"XXXXXXXX", "name"=>"Board of Governors of the Federal Reserve System", "country"=>"US", "currency"=>"USD", "website"=>"http://www.federalreserve.gov"}, "rates"=>[{"iso_from"=>"USD", "iso_to"=>"EUR", "rate"=>0.885582713425434, "inverse_rate"=>1.1292, "date"=>"2016-03-18"}]}    
+```
+
+```ruby  
+  response.pagination
+  {"current_page"=>1, "last_page"=>true, "per_page"=>200, "next_page_url"=>nil}   
+```
+
+:warning: Please use pagination by providing a block. Otherwise first page returns.
+
+```ruby
+  data = []
+  @cli.bank("XXXXXXXX").json{ |response| data.concat(response.data)  }     
 ```
 
 ## Rates list
@@ -112,6 +141,18 @@ This is the Ruby API client for the BankExchange service. Please read the offici
   {"params"=>{"date"=>"2016-03-24", "swift"=>[], "iso_from"=>["BYR"], "iso_to"=>["USD"], "fallback_days"=>5}, "rates"=>[{"iso_from"=>"BYR", "iso_to"=>"USD", "rate"=>4.96007142502852e-05, "inverse_rate"=>20161.0, "swift"=>"NBRBBY2X", "date"=>"2016-03-24"}]}      
 ```
 
+```ruby  
+  response.pagination
+  {"current_page"=>1, "last_page"=>false, "per_page"=>200, "next_page_url"=>"http://api.bank.exchange/rates?iso_from=&iso_to=&page=2&swift="}    
+```
+
+:warning: Please use pagination by providing a block. Otherwise first page returns.
+
+```ruby
+  data = []
+  @cli.rates.json{ |response| data.concat(response.data) }     
+```
+
 ## Rate overview
 
 ```ruby
@@ -138,3 +179,14 @@ This is the Ruby API client for the BankExchange service. Please read the offici
   {"params"=>{"iso_code"=>"BYR", "date"=>"2016-03-25", "iso_from"=>["BYR"], "iso_to"=>["RUB"], "fallback_days"=>5}, "rates"=>[{"iso_from"=>"BYR", "iso_to"=>"RUB", "rate"=>0.00340193910529002, "inverse_rate"=>293.95, "swift"=>"NBRBBY2X", "date"=>"2016-03-25"}]}       
 ```
 
+```ruby  
+  response.pagination
+  {"current_page"=>1, "last_page"=>true, "per_page"=>200, "next_page_url"=>nil}     
+```
+
+:warning: Please use pagination by providing a block. Otherwise first page returns.
+
+```ruby
+  data = []
+  @cli.rate('BYR').json{ |response| data.concat(response.data) }  
+```

data/lib/bank_exchange_api.rb

@@ -35,6 +35,10 @@ module BankExchangeApi
       logger && logger.error(value)
     end
 
+    def warn(value)
+      logger && logger.warn(value)
+    end
+
     # @return [Boolean]
     def ping
       Request::Ping.new(self).json.success?

data/lib/bank_exchange_api/config.rb

@@ -7,7 +7,7 @@ module BankExchangeApi
       names.each do |name|
         class_eval <<-METHODS, __FILE__, __LINE__ + 1
           def #{name}
-            @#{name} || self.class.#{name}
+            (defined?(@#{name}) && @#{name}) || self.class.#{name}
           end
 
           def #{name}!

data/lib/bank_exchange_api/param.rb

@@ -8,16 +8,18 @@ module BankExchangeApi
           end
 
           def #{name}
+            value = @#{name} if defined?(@#{name})
+
             @_#{name}_ ||= case #{klass}.name
               when 'Array'
-                Array(@#{name})
+                Array(value)
               when 'String'
-                String(@#{name}) if @#{name}
+                String(value) if value
               when 'Integer'
-                Integer(@#{name}) if @#{name}
+                Integer(value) if value
               when 'Date'
-                if @#{name}
-                  @#{name}.is_a?(Date) ? @#{name} : Date.parse(@#{name}.to_s)
+                if value
+                  value.is_a?(Date) ? value : Date.parse(value.to_s)
                 end
               else
                 raise UnsupportedParamClass, "Provide #{klass} class processing"

data/lib/bank_exchange_api/request/bank.rb

@@ -1,7 +1,7 @@
 module BankExchangeApi::Request
   class Bank < Base
     param :swift, String
-    param :currencies, Array
+    param :iso_to, Array
     param :date, Date
     param :fallback_days, Integer
 
@@ -11,7 +11,7 @@ module BankExchangeApi::Request
 
     def params
       {
-          currencies: currencies.join(','),
+          iso_to: iso_to.join(','),
           date: date,
           fallback_days: fallback_days,
       }

data/lib/bank_exchange_api/request/base.rb

@@ -18,8 +18,14 @@ module BankExchangeApi
         cli.connection.get(*args)
       end
 
-      def json(root: nil)
-        BankExchangeApi::Response::Json.new(get(query), root: root)
+      def json(root: nil, &block)
+        paginator = -> (uri=query) { BankExchangeApi::Response::Json.new(get(uri), root: root) }
+
+        if block_given?
+          paginate(paginator) { |response| yield(response) }
+        else
+          paginate(paginator)
+        end
       end
 
       def params
@@ -29,6 +35,28 @@ module BankExchangeApi
       def endpoint
         raise NotImplementedError, __method__
       end
+
+      private
+
+      # @param paginator [Proc] should accept next page uri
+      # @block if not given - first response return
+      def paginate(paginator)
+        response = paginator.call
+
+        unless block_given?
+          if response.paginatable?
+            cli.warn('Requested resource contains a pagination, please provide a block to process each page. Initial page returned.')
+          end
+          return response
+        end
+
+        yield(response)
+
+        while response.paginatable? do
+          response = paginator.call(response.next_page_url)
+          yield(response)
+        end
+      end
     end
   end
 end

data/lib/bank_exchange_api/response/base.rb

@@ -32,5 +32,21 @@ module BankExchangeApi::Response
     def body
       raise NotImplementedError, __method__
     end
+
+    def pagination
+      raise NotImplementedError, __method__
+    end
+
+    def next_page_url
+      raise NotImplementedError, __method__
+    end
+
+    def paginatable?
+      !next_page_url.nil?
+    end
+
+    def not_paginatable?
+      !paginatable?
+    end
   end
 end

data/lib/bank_exchange_api/response/json.rb

@@ -15,12 +15,20 @@ module BankExchangeApi::Response
       body.fetch('params', {})
     end
 
+    def pagination
+      body.fetch('pagination', {})
+    end
+
+    def next_page_url
+      pagination['next_page_url']
+    end
+
     def data
       root ? body[root.to_s] : body
     end
 
     def inspect
-      data
+      body
     end
   end
 end

data/lib/bank_exchange_api/version.rb

@@ -1,3 +1,3 @@
 module BankExchangeApi
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bank_exchange_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".env.example"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile