bitpay-sdk 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5f07e2ece3936d90f1855bf3c7c7c47e1528943
-  data.tar.gz: 2d7f13e49b0a7a0ce03804c99654c171a176cd86
+  metadata.gz: f17aaeed06964a9e0cb8aaa38e8e291b5135e0e2
+  data.tar.gz: c84ffdc47caf825006420824e3f63b61a22bc27a
 SHA512:
-  metadata.gz: 2041a1d3930606a93371eb07f18af6700b51e95a3c7992093f66a702f3dc2eb4da2a45c104b14387ec3f3ddd5d783c376f112142eaaf24669783095c7140a4d2
-  data.tar.gz: 6b176eb98b9263f49269db988fe046c914133a62dd08d2c36e1e8d92a66cf234849261c8fda152686b6759aea36394cfcf8b51ea0562f8886486c0d5b7c9907b
+  metadata.gz: 66d9265331b654fa308f0ae24782fe62d9a0b113e5a470341400d329edd0e3a4b71c36964f02a9c5e0c6a793a702e8444c98357728c0efa84c6f65ae9c000117
+  data.tar.gz: 86f177707cbc8f8c2f71d4a4b031153935ce62e3fef1be0077f26de57dd77b9076f4d1a579a60e6266e537f8e571bdd030defb89dff6a5917b0639dae61ce927

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.3.3] - 2015-03-12
+### Changed
+- Pull refund functionality from 2.3 spec
+- Bump gem version
+
+### Fixed
+- Fix Bug: GitHub issue #40 - error on return from endpoints that do not have a "data" field

data/config/constants.rb

@@ -11,9 +11,9 @@ TEST_PASS = ENV['RCTESTPASSWORD']
 DASHBOARD_URL = "#{ROOT_ADDRESS}/dashboard/merchant/home"
 
 unless
-	ROOT_ADDRESS &&
-	TEST_USER &&
-	TEST_PASS
+  ROOT_ADDRESS &&
+  TEST_USER &&
+  TEST_PASS
 then
-	raise "Missing configuration options - see constants.rb"
+  raise "Missing configuration options - see constants.rb"
 end

data/features/creating_invoices.feature

@@ -21,8 +21,8 @@ Feature: creating an invoice
     Then they will receive a BitPay::ArgumentError matching <message>
   Examples:
     | price    | currency  | message                              |
-    | "5,023"  | "USD"     | "Price must be formatted as a float" |
-    | "3.21"   | "EaUR"    | "Currency is invalid."               |
+    | "5,023" | "USD"     | "Price must be formatted as a float" |
+    | "3.21"  | "EaUR"    | "Currency is invalid."               |
     | ""       | "USD"     | "Price must be formatted as a float" |
     | "Ten"    | "USD"     | "Price must be formatted as a float" |
-    | "10"     | ""        | "Currency is invalid."               |
+    | "10"    | ""        | "Currency is invalid."               |

data/features/step_definitions/keygen_steps.rb

@@ -61,5 +61,5 @@ Given(/^the user requests a client\-side pairing$/) do
 end
 
 Then(/^they will receive a claim code$/) do
-  expect(@response["data"].first["pairingCode"] ).not_to be_empty
+  expect(@response.first["pairingCode"] ).not_to be_empty
 end

data/features/step_definitions/step_helpers.rb

@@ -66,7 +66,7 @@ def new_client_from_stored_values
 end
 
 def get_token_from_file
-  token = JSON.parse(File.read(BitPay::TOKEN_FILE_PATH))['data'][0]
+  token = JSON.parse(File.read(BitPay::TOKEN_FILE_PATH))[0]
   {token['facade'] => token['token']}
 end
 

data/lib/bitpay/client.rb

@@ -1,4 +1,4 @@
-# license Copyright 2011-2014 BitPay, Inc., MIT License
+# license Copyright 2011-2015 BitPay, Inc., MIT License
 # see http://opensource.org/licenses/MIT
 # or https://github.com/bitpay/php-bitpay-client/blob/master/LICENSE
 
@@ -7,13 +7,14 @@ require 'net/https'
 require 'json'
 
 require_relative 'key_utils'
+require_relative 'rest_connector'
 
 module BitPay
   # This class is used to instantiate a BitPay Client object. It is expected to be thread safe.
   #
   module SDK
     class Client
-      
+      include BitPay::RestConnector 
       # @return [Client]
       # @example
       #  # Create a client with a pem file created by the bitpay client:
@@ -46,7 +47,8 @@ module BitPay
       # => Pass {pairingCode: 'WfD01d2'} to claim a server-initiated pairing code
       #
       def pair_client(params={})
-        pairing_request(params)
+        tokens = post(path: 'tokens', params: params)
+        return tokens["data"]
       end
 
       ## Compatibility method for pos pairing
@@ -67,24 +69,16 @@ module BitPay
           currency == 'BTC' && /^[[:digit:]]+(\.[[:digit:]]{1,6})?$/.match(price)
         raise BitPay::ArgumentError, "Illegal Argument: Currency is invalid." unless /^[[:upper:]]{3}$/.match(currency)
         params.merge!({price: price, currency: currency})
-        response = send_request("POST", "invoices", facade: facade, params: params)
-        response["data"]
+        token = get_token(facade)
+        invoice = post(path: "invoices", token: token, params: params)
+        invoice["data"]
       end
 
-      ## Gets the privileged merchant-version of the invoice
-      #   Requires merchant facade token
-      #
-      def get_invoice(id:)
-        response = send_request("GET", "invoices/#{id}", facade: 'merchant')
-        response["data"]        
-      end
-      
       ## Gets the public version of the invoice
       #
       def get_public_invoice(id:)
-        request = Net::HTTP::Get.new("/invoices/#{id}")
-        response = process_request(request)
-        response["data"]
+        invoice = get(path: "invoices/#{id}", public: true)
+        invoice["data"]
       end
       
       ## Checks that the passed tokens are valid by
@@ -98,116 +92,12 @@ module BitPay
         tokens.each{|key, value| return false if server_tokens[key] != value}
         return true
       end
-      
-      ## Generates REST request to api endpoint
-      # =>  Defaults to merchant facade unless token or facade is explicitly provided
-      #
-      def send_request(verb, path, facade: 'merchant', params: {}, token: nil)
-        token ||= get_token(facade)
-
-        # Verb-specific logic
-        case verb.upcase
-          when "GET"
-            urlpath = '/' + path + '?token=' + token
-            request = Net::HTTP::Get.new urlpath
-            request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key)
-
-          when "PUT"
-
-          when "POST"  # Requires a GUID
-
-            urlpath = '/' + path
-            request = Net::HTTP::Post.new urlpath
-            params[:token] = token
-            params[:guid]  = SecureRandom.uuid
-            params[:id] = @client_id
-            request.body = params.to_json
-            request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath + request.body, @priv_key)
-
-          when "DELETE"
-         
-            raise(BitPayError, "Invalid HTTP verb: #{verb.upcase}")
-        end
-
-        # Build request headers and submit
-        request['X-Identity'] = @pub_key
-   
-        response = process_request(request)
-      end
 
-  ##### PRIVATE METHODS #####
       private
 
-      ## Processes HTTP Request and returns parsed response
-      # Otherwise throws error
-      #
-      def process_request(request)
-
-        request['User-Agent'] = @user_agent
-        request['Content-Type'] = 'application/json'
-        request['X-BitPay-Plugin-Info'] = 'Rubylib' + VERSION
-
-        begin
-          response = @https.request request
-        rescue => error
-          raise BitPay::ConnectionError, "#{error.message}"
-        end
-
-        if response.kind_of? Net::HTTPSuccess
-          return JSON.parse(response.body)
-        elsif JSON.parse(response.body)["error"]
-          raise(BitPayError, "#{response.code}: #{JSON.parse(response.body)['error']}")
-        else
-          raise BitPayError, "#{response.code}: #{JSON.parse(response.body)}"
-        end
-          
-      end
-
-      ## Fetches the tokens hash from the server and
-      #  updates @tokens
-      #
-      def refresh_tokens
-        urlpath = '/tokens'
-
-        request = Net::HTTP::Get.new(urlpath)
-        request['X-Identity'] = @pub_key
-        request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key)
-
-        response = process_request(request)
-        token_array = response["data"] || {}
-
-        tokens = {}
-        token_array.each do |t|
-          tokens[t.keys.first] = t.values.first
-        end
-
-        @tokens = tokens
-        return tokens
-
-      end
-
-      ## Makes a request to /tokens for pairing
-      #     Adds passed params as post parameters
-      #     If empty params, retrieves server-generated pairing code
-      #     If pairingCode key/value is passed, will pair client ID to this account
-      #   Returns response hash
-      #
-      def pairing_request(params)
-        urlpath = '/tokens'
-        request = Net::HTTP::Post.new urlpath
-        params[:guid] = SecureRandom.uuid
-        params[:id] = @client_id
-        request.body = params.to_json
-        process_request(request)
-      end
-
-      def get_token(facade)
-        token = @tokens[facade] || refresh_tokens[facade] || raise(BitPayError, "Not authorized for facade: #{facade}")
-      end
-
       def verify_claim_code(claim_code)
         regex = /^[[:alnum:]]{7}$/
-        matches = regex.match(claim_code)
+          matches = regex.match(claim_code)
         !(matches.nil?)
       end
     end

data/lib/bitpay/rest_connector.rb

@@ -0,0 +1,96 @@
+# license Copyright 2011-2015 BitPay, Inc., MIT License
+# see http://opensource.org/licenses/MIT
+# or https://github.com/bitpay/php-bitpay-client/blob/master/LICENSE
+
+module BitPay
+  module RestConnector
+    def send_request(verb, path, facade: 'merchant', params: {}, token: nil)
+      token ||= get_token(facade)
+      case verb.upcase
+      when "GET"
+        return get(path: path, token:token)
+      when "POST"
+        return post(path: path, token: token, params: params)
+      else
+        raise(BitPayError, "Invalid HTTP verb: #{verb.upcase}")
+      end
+    end
+
+    def get(path:, token: nil, public: false)
+      urlpath = '/' + path
+      urlpath = urlpath + '?token=' + token if token
+      request = Net::HTTP::Get.new urlpath
+      unless public
+        request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key) 
+        request['X-Identity'] = @pub_key
+      end
+      process_request(request)
+    end
+
+    def post(path:, token: nil, params:)
+      urlpath = '/' + path
+      request = Net::HTTP::Post.new urlpath
+      params[:token] = token if token
+      params[:guid]  = SecureRandom.uuid
+      params[:id] = @client_id
+      request.body = params.to_json
+      if token
+        request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath + request.body, @priv_key)
+        request['X-Identity'] = @pub_key
+      end
+      process_request(request)
+    end
+
+    private
+
+    ## Processes HTTP Request and returns parsed response
+    # Otherwise throws error
+    #
+    def process_request(request)
+      request['User-Agent'] = @user_agent
+      request['Content-Type'] = 'application/json'
+      request['X-BitPay-Plugin-Info'] = 'Rubylib' + VERSION
+
+      begin
+        response = @https.request request
+      rescue => error
+        raise BitPay::ConnectionError, "#{error.message}"
+      end
+
+      if response.kind_of? Net::HTTPSuccess
+        return JSON.parse(response.body)
+      elsif JSON.parse(response.body)["error"]
+        raise(BitPayError, "#{response.code}: #{JSON.parse(response.body)['error']}")
+      else
+        raise BitPayError, "#{response.code}: #{JSON.parse(response.body)}"
+      end
+
+    end
+
+    ## Fetches the tokens hash from the server and
+    #  updates @tokens
+    #
+    def refresh_tokens
+      response = get(path: 'tokens')["data"]
+      token_array = response || {}
+      tokens = {}
+      token_array.each do |t|
+        tokens[t.keys.first] = t.values.first
+      end
+      @tokens = tokens
+      return tokens
+    end
+
+    ## Makes a request to /tokens for pairing
+    #     Adds passed params as post parameters
+    #     If empty params, retrieves server-generated pairing code
+    #     If pairingCode key/value is passed, will pair client ID to this account
+    #   Returns response hash
+    #
+
+    def get_token(facade)
+      token = @tokens[facade] || refresh_tokens[facade] || raise(BitPayError, "Not authorized for facade: #{facade}")
+    end
+
+  end
+end

data/lib/bitpay/version.rb

@@ -3,5 +3,5 @@
 # or https://github.com/bitpay/php-bitpay-client/blob/master/LICENSE
 
 module BitPay
-  VERSION = '2.3.2'
+  VERSION = '2.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitpay-sdk
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Bitpay, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -215,6 +215,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - GUIDE.md
 - Gemfile
 - LICENSE.md
@@ -232,6 +233,7 @@ files:
 - lib/bitpay/cacert.pem
 - lib/bitpay/client.rb
 - lib/bitpay/key_utils.rb
+- lib/bitpay/rest_connector.rb
 - lib/bitpay/version.rb
 - lib/bitpay_sdk.rb
 - spec/client_spec.rb