button 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2044d12c6c7ac2d7a5a17977bab5efea1f3f2e06
-  data.tar.gz: 889c82be7e57d528be2236d9748fbf1894ab19fc
+  metadata.gz: 8c99e53a991580d4ccf787e866dfc435ed99090d
+  data.tar.gz: 3b9d4af4a221e92e4f870fd4c706955690091c12
 SHA512:
-  metadata.gz: f6ad5f1844dd9bd486908695cd5a625a00bf2e24ac38081e2f75381c5b8e9ecf6f74abb67c52dc208d7f5f060ec6df85982d7a6ce7bc788db1e948d47d0a3e3e
-  data.tar.gz: 849199911f68fae4512d5c640ac3cdba527fd5dabcc822d8b3b834f27f6934a42760566cf9c14627ea27634b7d56c01646eb404a2153b57a407bb197038716ce
+  metadata.gz: 918982fd3a17f23def37a8630f14b871aa0eabf9e375bf96a3a2827c93d3b9976605e5cb0e8324050d23ac90aef876293398ec75f412ad5c1332f9a544d34d49
+  data.tar.gz: 735d632b7e1f1c2efe208142942623827fbb8acc2c40f5c870379810277de4021377d74454ba6a8568140709a290a7edac759aa2e27d8a914114d4ce64dd3659

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Current Version
   -
 
+2.5.0 September 25, 2019
+  - Added CODEOWNERS
+  - Add `Offers` resource
+  - Add `Transactions` resource and time field support
+
 2.4.0 December 6, 2017
   - Add `Links` resource
 

data/README.md

@@ -84,6 +84,8 @@ We currently expose the following resources to manage:
 * [`Merchants`](#merchants)
 * [`Orders`](#orders)
 * [`Links`](#links)
+* [`Offers`](#offers)
+* [`Transactions`](#transactions)
 
 ### Accounts
 
@@ -109,6 +111,7 @@ Along with the required account id, you may also pass the following optional arg
 * `:cursor` (String): An API cursor to fetch a specific set of results.
 * `:start` (ISO-8601 datetime String): Fetch transactions after this time.
 * `:end` (ISO-8601 datetime String): Fetch transactions before this time.
+* `:time_field` (String): Which time field start and end filter on.
 
 ```ruby
 require 'button'
@@ -281,6 +284,56 @@ puts response
 # => Button::Response()
 ```
 
+### Offers
+
+##### Get Offers
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.offers.get({
+    user_id: "some-user-id",
+    device_ids: ["123"]
+})
+
+puts response
+# => Button::Response()
+```
+
+### Transactions
+
+#### All
+
+_n.b. all is a paged endpoint.  Take care to inspect `response.next_cursor` in case there's more data to be read._
+
+You may pass the following optional arguments as a Hash:
+
+* `:cursor` (String): An API cursor to fetch a specific set of results.
+* `:start` (ISO-8601 datetime String): Fetch transactions after this time.
+* `:end` (ISO-8601 datetime String): Fetch transactions before this time.
+* `:time_field` (String): Which time field start and end filter on.
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.transactions.all
+cursor = response.next_cursor
+
+puts response
+# => Button::Response(75 elements)
+
+# Unpage all results
+#
+while !cursor.nil? do
+  response = client.transactions.all(cursor: cursor)
+  cursor = response.next_cursor
+end
+```
+
 ## 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.rb

@@ -1,3 +1,4 @@
 require 'button/client'
+require 'button/constants'
 require 'button/version'
 require 'button/utils'

data/lib/button/client.rb

@@ -2,7 +2,9 @@ require 'button/resources/accounts'
 require 'button/resources/customers'
 require 'button/resources/links'
 require 'button/resources/merchants'
+require 'button/resources/offers'
 require 'button/resources/orders'
+require 'button/resources/transactions'
 require 'button/errors'
 
 NO_API_KEY_MESSAGE = 'Must provide a Button API key.  Find yours at '\
@@ -31,7 +33,9 @@ module Button
       @customers = Customers.new(api_key, config_with_defaults)
       @links = Links.new(api_key, config_with_defaults)
       @merchants = Merchants.new(api_key, config_with_defaults)
+      @offers = Offers.new(api_key, config_with_defaults)
       @orders = Orders.new(api_key, config_with_defaults)
+      @transactions = Transactions.new(api_key, config_with_defaults)
     end
 
     def merge_defaults(config)
@@ -46,7 +50,7 @@ module Button
       }
     end
 
-    attr_reader :accounts, :customers, :merchants, :orders, :links
+    attr_reader :accounts, :customers, :merchants, :offers, :orders, :links, :transactions
     private :merge_defaults
   end
 end

data/lib/button/constants.rb

@@ -0,0 +1,6 @@
+module Button
+  module Constants
+    TIME_FIELD_CREATED = 'created_date'.freeze
+    TIME_FIELD_MODIFIED = 'modified_date'.freeze
+  end
+end

data/lib/button/resources/accounts.rb

@@ -25,6 +25,7 @@ module Button
     #   transactions
     # @option [ISO-8601 datetime String] end The end date to filter
     #   transactions
+    # @option [String] time_field time field start and end filter on
     # @return [Button::Response] the API response
     #
     def transactions(account_id, opts = {})
@@ -32,6 +33,7 @@ module Button
       query['cursor'] = opts[:cursor] if opts[:cursor]
       query['start'] = opts[:start] if opts[:start]
       query['end'] = opts[:end] if opts[:end]
+      query['time_field'] = opts[:time_field] if opts[:time_field]
 
       api_get(path(account_id), query)
     end

data/lib/button/resources/offers.rb

@@ -0,0 +1,20 @@
+require 'button/resources/resource'
+
+module Button
+  # https://www.usebutton.com/developers/api-reference/
+  #
+  class Offers < Resource
+    def path
+      '/v1/offers'
+    end
+
+    # Retrieve offers that are available to Publishers user
+    #
+    # @param [Hash] user to retrieve offers for
+    # @return [Button::Response] the API response
+    #
+    def get(user)
+      api_post(path, user)
+    end
+  end
+end

data/lib/button/resources/transactions.rb

@@ -0,0 +1,27 @@
+require 'button/resources/resource'
+
+module Button
+  # https://www.usebutton.com/developers/api-reference/
+  #
+  class Transactions < Resource
+    # Gets a list of transactions
+    #
+    # @option [String] cursor the account id to look up transactions for
+    # @option [ISO-8601 datetime String] start The start date to filter
+    #   transactions
+    # @option [ISO-8601 datetime String] end The end date to filter
+    #   transactions
+    # @option [String] time_field time field start and end filter on
+    # @return [Button::Response] the API response
+    #
+    def all(opts = {})
+      query = {}
+      query['cursor'] = opts[:cursor] if opts[:cursor]
+      query['start'] = opts[:start] if opts[:start]
+      query['end'] = opts[:end] if opts[:end]
+      query['time_field'] = opts[:time_field] if opts[:time_field]
+
+      api_get('/v1/affiliation/transactions', query)
+    end
+  end
+end

data/lib/button/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: button
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Button
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies: []
 description: Button is a contextual acquisition channel and closed-loop attribution
   and affiliation system for mobile commerce.
@@ -23,13 +23,16 @@ files:
 - README.md
 - lib/button.rb
 - lib/button/client.rb
+- lib/button/constants.rb
 - 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/offers.rb
 - lib/button/resources/orders.rb
 - lib/button/resources/resource.rb
+- lib/button/resources/transactions.rb
 - lib/button/response.rb
 - lib/button/utils.rb
 - lib/button/version.rb
@@ -53,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: ruby client for the Button Order API