button 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 4e8a1c32105113a4aef997c0174e04b9837bcd21
-  data.tar.gz: c2b15b144b667bc8a20ae4be470a37b899251acc
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTRlYTE4OWNjZGQyY2I0MzE1ZTU5NTg2OTA2YTFiMTA5MTU1ZDQ4Yw==
+  data.tar.gz: !binary |-
+    NzJjMWY5NDcyZDE3OWExNjkwYWQwYTc4YjY5YjdiMmJlN2UzYWUzMg==
 SHA512:
-  metadata.gz: 2257e0e49af63ae6f832dc56f5b6da8009b68bd449e2505dfce55d00554a8ea56c31031513fb3aefc3a80dc8cc8b818b2206f5a952740cf0c50bf1ca00ca21f9
-  data.tar.gz: a49d781607063a3e2635eeb957624bc7c5723d552a1839445f6b8e3410ff9e7fc8020c4468dbe04319027ce0c03cc8cc211891dbfc5dd65eac2be987fe53db96
+  metadata.gz: !binary |-
+    MDVkZjFjMjI5ZWU1YjE3NGUxODgzMWM2YTJjY2I2NmZiZjQ4YmQ0ZTFhNWE4
+    ZTBkZDMzNzgyZGVlYjIwZjY3MTQxNzIwZDY2Y2U1NTBhYjFkMDNlMzhjM2Ew
+    ZjZiMjg0YjMzZDEzMzgxZDk3YzYyZTAxMDE5NGJkNDk0NjE5OGM=
+  data.tar.gz: !binary |-
+    ODNmYzAzZWRiOWIwYWVlZTYyZTBiOWQ1YjgxMjk3OWY1MDlkOTIzYmNhOTQ4
+    YjVkMWViYjM1YjFiNmEwZTI5ZTQ3NzE2YjA4MjUwZDRiZDMyNDM5ODJlYTUz
+    Zjc0ZDZjMjYyZjVmZjNiODU1NTc3N2Q5MTk4ZWY2Y2ViMzEyMmQ=

data/README.md

@@ -1,4 +1,4 @@
-# button-client-ruby [![Build Status](https://travis-ci.com/button/button-client-ruby.svg?token=HswVzGqEpwteP838Y3ss&branch=master)](https://travis-ci.com/button/button-client-ruby)
+# button-client-ruby [![Build Status](https://travis-ci.org/button/button-client-ruby.svg?branch=master)](https://travis-ci.org/button/button-client-ruby)
 
 This module is a thin client for interacting with Button's API.
 
@@ -53,6 +53,28 @@ puts response.to_hash()
 
 n.b. the keys of the response hash will always be symbols. 
 
+## Configuration
+
+You may optionally supply a config argument with your API key:
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX', {
+  hostname: 'api.testsite.com',
+  port: 3000,
+  secure: false,
+  timeout: 5 # seconds
+})
+```
+
+The supported options are as follows:
+
+* `hostname`: Defaults to `api.usebutton.com`.
+* `port`: Defaults to `443` if `config.secure`, else defaults to `80`.
+* `secure`: Whether or not to use HTTPS. Defaults to True.  **N.B: Button's API is only exposed through HTTPS. This option is provided purely as a convenience for testing and development.**
+* `timeout`: The time in seconds that may elapse before network requests abort. Defaults to `nil`.
+
 ## Resources
 
 We currently expose only one resource to manage, `Orders`. 
@@ -72,7 +94,8 @@ response = client.orders.create({
   total: 50,
   currency: 'USD',
   order_id: '1994',
-  finalization_date: '2017-08-02T19:26:08Z'
+  finalization_date: '2017-08-02T19:26:08Z',
+  btn_ref: 'srctok-XXX'
 })
 
 puts response 

data/lib/button/client.rb

@@ -1,6 +1,9 @@
 require 'button/resources/orders'
 require 'button/errors'
 
+NO_API_KEY_MESSAGE = 'Must provide a Button API key.  Find yours at '\
+  'https://app.usebutton.com/settings/organization'
+
 module Button
   # Client is the top-level interface for the Button API.  It exposes one
   # resource currently: `.orders`.  It requires a valid API key to make
@@ -13,14 +16,28 @@ module Button
   # puts client.orders.get("btnorder-XXX")
   #
   class Client
-    def initialize(api_key)
+    def initialize(api_key, config = {})
       if api_key.nil? || api_key.empty?
-        raise ButtonClientError, 'Must provide a Button API key.  Find yours at https://app.usebutton.com/settings/organization'
+        raise ButtonClientError, NO_API_KEY_MESSAGE
       end
 
-      @orders = Orders.new(api_key)
+      config_with_defaults = merge_defaults(config)
+
+      @orders = Orders.new(api_key, config_with_defaults)
+    end
+
+    def merge_defaults(config)
+      secure = config.fetch(:secure, true)
+
+      return {
+        secure: secure,
+        timeout: config.fetch(:timeout, nil),
+        hostname: config.fetch(:hostname, 'api.usebutton.com'),
+        port: config.fetch(:port, secure ? 443 : 80)
+      }
     end
 
     attr_reader :orders
+    private :merge_defaults
   end
 end

data/lib/button/resources/resource.rb

@@ -24,14 +24,21 @@ module Button
   # end
   #
   class Resource
-    HOST = 'api.usebutton.com'.freeze
-    PORT = 443
     USER_AGENT = "Button/#{Button::VERSION} ruby/#{RUBY_VERSION}".freeze
 
-    def initialize(api_key)
+    def initialize(api_key, config)
       @api_key = api_key
-      @http = Net::HTTP.new(HOST, PORT)
-      @http.use_ssl = true
+      @config = config
+      @http = Net::HTTP.new(config[:hostname], config[:port])
+      @http.use_ssl = config[:secure]
+
+      if not config[:timeout].nil?
+        @http.read_timeout = config[:timeout]
+      end
+    end
+
+    def timeout
+      @http.read_timeout
     end
 
     # Performs an HTTP GET at the provided path.
@@ -96,6 +103,7 @@ module Button
       raise ButtonClientError, "Invalid response: #{parsed}"
     end
 
+    attr_accessor :config
     private :api_request, :process_response
   end
 end

data/lib/button/version.rb

@@ -1,3 +1,3 @@
 module Button
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: button
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Button
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies: []
 description: Button is a contextual acquisition channel and closed-loop attribution
   and affiliation system for mobile commerce.
@@ -38,17 +38,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: ruby client for the Button Order API