button 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61d27733d5ecb2d4779f291f82fbb0906468b6af
-  data.tar.gz: 770aa00ad2c627ac5cbbfe9feb15376096e52375
+  metadata.gz: 2044d12c6c7ac2d7a5a17977bab5efea1f3f2e06
+  data.tar.gz: 889c82be7e57d528be2236d9748fbf1894ab19fc
 SHA512:
-  metadata.gz: 2709f2d4a60695476ec904937dfbd86e27f8c02a055a01761eb4efa4fbf976514f812f94c305a0c38c148522c0a98096235d7969b974768dc90b15df218d1e64
-  data.tar.gz: 502473e5e71c8c8c45c4d7db6c5ad011303dabcd0017c4adf345f1ae48525e88ef562a029a8daeadf77e7dc86334a34eedac705072b9fc769889a7881acc74fc
+  metadata.gz: f6ad5f1844dd9bd486908695cd5a625a00bf2e24ac38081e2f75381c5b8e9ecf6f74abb67c52dc208d7f5f060ec6df85982d7a6ce7bc788db1e948d47d0a3e3e
+  data.tar.gz: 849199911f68fae4512d5c640ac3cdba527fd5dabcc822d8b3b834f27f6934a42760566cf9c14627ea27634b7d56c01646eb404a2153b57a407bb197038716ce

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 Current Version
   -
 
+2.4.0 December 6, 2017
+  - Add `Links` resource
+
 2.3.0 June 22, 2017
   - Add api_version to Client config
 

data/README.md

@@ -18,7 +18,7 @@ Please see the full [API Docs](https://www.usebutton.com/developers/api-referenc
 gem install button
 ```
 
-To create a client capable of making network requests, instantiate a  `Button::Client` with your [API key](https://app.usebutton.com/settings/organization). 
+To create a client capable of making network requests, instantiate a  `Button::Client` with your [API key](https://app.usebutton.com/settings/organization).
 
 ```ruby
 require 'button'
@@ -26,7 +26,7 @@ require 'button'
 client = Button::Client.new('sk-XXX')
 ```
 
-The client will always attempt to raise a `Button::ButtonClientError` in an error condition. 
+The client will always attempt to raise a `Button::ButtonClientError` in an error condition.
 
 All API requests will return a `Button::Response` instance.  To access the response data, invoke `#data`.
 
@@ -83,6 +83,7 @@ We currently expose the following resources to manage:
 * [`Customers`](#customers)
 * [`Merchants`](#merchants)
 * [`Orders`](#orders)
+* [`Links`](#links)
 
 ### Accounts
 
@@ -139,7 +140,7 @@ client = Button::Client.new('sk-XXX')
 
 response = client.customers.create({
   id: 'internal-customer-id',
-  email_sha256: 'a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3'
+  email_sha256: Digest::SHA256.hexdigest('user@example.com'.downcase.strip)
 })
 
 puts response
@@ -194,7 +195,11 @@ response = client.orders.create({
   currency: 'USD',
   order_id: '1994',
   finalization_date: '2017-08-02T19:26:08Z',
-  btn_ref: 'srctok-XXX'
+  btn_ref: 'srctok-XXX',
+  customer: {
+    id: 'mycustomer-1234',
+    email_sha256: Digest::SHA256.hexdigest('user@example.com'.downcase.strip)
+  }
 })
 
 puts response
@@ -240,6 +245,42 @@ puts response
 # => Button::Response()
 ```
 
+### Links
+
+##### Create
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.links.create({
+    url: "https://www.jet.com",
+    experience: {
+        btn_pub_ref: "my-pub-ref",
+        btn_pub_user: "user-id"
+    }
+})
+
+puts response
+# => Button::Response()
+```
+
+##### Get Info
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.links.get_info({
+    url: "https://www.jet.com"
+})
+
+puts response
+# => Button::Response()
+```
+
 ## Response
 
 An instance of the `Button::Response` class will be returned by all API methods.  It is used to read the response data as well as collect any meta data about the response, like potential next and previous cursors to more data in a paged endpoint.

data/lib/button/client.rb

@@ -1,5 +1,6 @@
 require 'button/resources/accounts'
 require 'button/resources/customers'
+require 'button/resources/links'
 require 'button/resources/merchants'
 require 'button/resources/orders'
 require 'button/errors'
@@ -28,6 +29,7 @@ module Button
 
       @accounts = Accounts.new(api_key, config_with_defaults)
       @customers = Customers.new(api_key, config_with_defaults)
+      @links = Links.new(api_key, config_with_defaults)
       @merchants = Merchants.new(api_key, config_with_defaults)
       @orders = Orders.new(api_key, config_with_defaults)
     end
@@ -44,7 +46,7 @@ module Button
       }
     end
 
-    attr_reader :accounts, :customers, :merchants, :orders
+    attr_reader :accounts, :customers, :merchants, :orders, :links
     private :merge_defaults
   end
 end

data/lib/button/resources/links.rb

@@ -0,0 +1,29 @@
+require 'button/resources/resource'
+
+module Button
+  # https://www.usebutton.com/developers/api-reference/
+  #
+  class Links < Resource
+    def path
+      '/v1/links'
+    end
+
+    # Create a Link
+    #
+    # @param [Hash] link the link to create
+    # @return [Button::Response] the API response
+    #
+    def create(link)
+      api_post(path, link)
+    end
+
+    # Get information for Link
+    #
+    # @param [Hash] link the link to get information on
+    # @return [Button::Response] the API response
+    #
+    def get_info(link)
+      api_post(path + '/info', link)
+    end
+  end
+end

data/lib/button/version.rb

@@ -1,3 +1,3 @@
 module Button
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: button
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Button
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies: []
 description: Button is a contextual acquisition channel and closed-loop attribution
   and affiliation system for mobile commerce.
@@ -26,6 +26,7 @@ files:
 - lib/button/errors.rb
 - lib/button/resources/accounts.rb
 - lib/button/resources/customers.rb
+- lib/button/resources/links.rb
 - lib/button/resources/merchants.rb
 - lib/button/resources/orders.rb
 - lib/button/resources/resource.rb