button 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7000fd76d3af3d8e674e4ef5764d9db85b0858be
+  data.tar.gz: 816710af43f2165f4a54cbfd785f43c797128cde
+SHA512:
+  metadata.gz: 5caa52ecc60d1ae70654006a7a20354c239fa3740dcbf7889c8fbaee83294847f07382ba60067a738dbf6573fa37de0939d18af9acf3dc885e73caf44ac7eb59
+  data.tar.gz: accbb50b91a0c6a1bd518eadb67fc9209958f7e26fe480dcf914e447fc569b8c487bc0ccc65ab310a6c3c66845188154b314e5648eece7bfbc5bb517ec6bcd58

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+0.0.1 August X, 2016
+  - Initial Release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Button
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# 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)
+
+This module is a thin client for interacting with Button's API.
+
+Please see the full [API Docs](https://www.usebutton.com/developers/api-reference) for more information.  
+
+#### Supported runtimes
+
+* Ruby (MRI) `>=1.9.3`
+
+#### Dependencies
+
+*  None
+
+## Usage
+
+```bash
+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). 
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+```
+
+The client will always attempt to raise a `Button::ButtonClientError` in an error condition. 
+
+All API requests will return a `Button::Response` instance, which supports accessing data properties from the API response as methods.  To access the raw response hash, use `#to_hash`.  For instance:
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+begin
+  response = client.orders.get('btnorder-XXX')
+rescue Button::ButtonClientError => error
+  puts error
+end
+
+puts response 
+# => Button::Response(button_order_id: btnorder-XXX, total: 60, ... )
+
+puts response.button_order_id
+# => btnorder-XXX
+
+puts response.to_hash()
+# => {:button_order_id=>'btnorder-29de0b1436075ea6', :total=>60, ... }
+```
+
+n.b. the keys of the response hash will always be symbols. 
+
+## Resources
+
+We currently expose only one resource to manage, `Orders`. 
+
+### Orders
+
+**n.b: all currency values should be reported in the smallest possible unit of that denomination, i.e. $1.00 should be reported as `100` (i.e. 100 pennies)**
+
+##### Create
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.orders.create({
+  total: 50,
+  currency: 'USD',
+  order_id: '1994',
+  finalization_date: '2017-08-02T19:26:08Z'
+})
+
+puts response 
+# => Button::Response(button_order_id: btnorder-XXX, total: 50, ... )
+```
+
+##### Get
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.orders.get('btnorder-XXX')
+
+puts response 
+# => Button::Response(button_order_id: btnorder-XXX, total: 50, ... )
+```
+##### Update
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.orders.update('btnorder-XXX', total: 60)
+
+puts response 
+# => Button::Response(button_order_id: btnorder-XXX, total: 60, ... )
+```
+
+##### Delete
+
+```ruby
+require 'button'
+
+client = Button::Client.new('sk-XXX')
+
+response = client.orders.delete('btnorder-XXX')
+
+puts response
+# => Button::Response()
+```
+
+## Contributing
+
+* Building the gem: `gem build button.gemspec`
+* Installing locally: `gem install ./button-X.Y.Z.gem`
+* Installing development dependencies: `bundle install`
+* Running tests: `bundle exec rake`

data/lib/button/client.rb

@@ -0,0 +1,26 @@
+require 'button/resources/orders'
+require 'button/errors'
+
+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
+  # requests on behalf of your organization, which can be found at
+  # https://app.usebutton.com/settings/organization.
+  #
+  # ## Usage
+  #
+  # client = Button::Client.new("sk-XXX")
+  # puts client.orders.get("btnorder-XXX")
+  #
+  class Client
+    def initialize(api_key)
+      if api_key.nil? || api_key.empty?
+        raise ButtonClientError, 'Must provide a Button API key.  Find yours at https://app.usebutton.com/settings/organization'
+      end
+
+      @orders = Orders.new(api_key)
+    end
+
+    attr_reader :orders
+  end
+end

data/lib/button/errors.rb

@@ -0,0 +1,4 @@
+module Button
+  class ButtonClientError < StandardError
+  end
+end

data/lib/button/resources/orders.rb

@@ -0,0 +1,49 @@
+require 'button/resources/resource'
+
+module Button
+  # https://www.usebutton.com/developers/api-reference/
+  #
+  class Orders < Resource
+    def path(order_id = nil)
+      return "/v1/order/#{order_id}" if order_id
+      '/v1/order'
+    end
+
+    # Gets an order
+    #
+    # @param [String] order_id the order id
+    # @return [Button::Response] the API response
+    #
+    def get(order_id)
+      api_get(path(order_id))
+    end
+
+    # Creates an order
+    #
+    # @param [Hash] order the order to create
+    # @return [Button::Response] the API response
+    #
+    def create(order)
+      api_post(path, order)
+    end
+
+    # Updates an order
+    #
+    # @param [String] order_id the order id
+    # @param [Hash] order the order to create
+    # @return [Button::Response] the API response
+    #
+    def update(order_id, order)
+      api_post(path(order_id), order)
+    end
+
+    # Deletes an order
+    #
+    # @param [String] order_id the order id
+    # @return [Button::Response] the API response
+    #
+    def delete(order_id)
+      api_delete(path(order_id))
+    end
+  end
+end

data/lib/button/resources/resource.rb

@@ -0,0 +1,101 @@
+require 'net/http'
+require 'json'
+
+require 'button/errors'
+require 'button/response'
+require 'button/version'
+
+module Button
+  # Resource is a handy base class for making API requests.  It includes
+  # serveral handy methods for making such requests:
+  #
+  # api_get(path)
+  # api_post(path, body)
+  # api_delete(path)
+  #
+  # ## Usage
+  #
+  # class Blorp < Button::Resource
+  #
+  #   def get(blorp_id)
+  #     api_get("/api/v1/blorps/#{blorp_id}")
+  #   end
+  #
+  # end
+  #
+  class Resource
+    HOST = 'api.usebutton.com'.freeze
+    PORT = 443
+    USER_AGENT = "Button/#{Button::VERSION} ruby/#{RUBY_VERSION}".freeze
+
+    def initialize(api_key)
+      @api_key = api_key
+      @http = Net::HTTP.new(HOST, PORT)
+      @http.use_ssl = true
+    end
+
+    # Performs an HTTP GET at the provided path.
+    #
+    # @param [String] path the HTTP path
+    # @return [Button::Response] the API response
+    #
+    def api_get(path)
+      api_request(Net::HTTP::Get.new(path))
+    end
+
+    # Performs an HTTP POST at the provided path.
+    #
+    # @param [String] path the HTTP path
+    # @param [Hash] body the HTTP request body
+    # @return [Button::Response] the API response
+    #
+    def api_post(path, body)
+      api_request(Net::HTTP::Post.new(path), body)
+    end
+
+    # Performs an HTTP DELETE at the provided path.
+    #
+    # @param [String] path the HTTP path
+    # @return [Button::Response] the API response
+    #
+    def api_delete(path)
+      api_request(Net::HTTP::Delete.new(path))
+    end
+
+    def api_request(request, body = nil)
+      request.basic_auth(@api_key, '')
+      request.add_field('User-Agent', USER_AGENT)
+
+      if !body.nil? && body.respond_to?(:to_json)
+        request.add_field('Content-Type', 'application/json')
+        request.body = body.to_json
+      end
+
+      body = @http.request(request).body
+      process_response(body)
+    end
+
+    def process_response(response)
+      if response.nil? || response.empty?
+        raise ButtonClientError, 'Client received an empty response from the server'
+      end
+
+      begin
+        parsed = JSON.parse(response, symbolize_names: true)
+      rescue
+        raise ButtonClientError, "Error parsing response as JSON: #{response}"
+      end
+
+      raise ButtonClientError, "Invalid response: #{parsed}" unless parsed[:meta].is_a?(Hash)
+
+      status = parsed[:meta][:status]
+
+      return Response.new(parsed[:object]) if status == 'ok'
+      raise ButtonClientError, "Unknown status: #{status}" unless status == 'error'
+      raise ButtonClientError, parsed[:error][:message] if parsed[:error].is_a?(Hash)
+      raise ButtonClientError, "Invalid response: #{parsed}"
+    end
+
+    private :api_request, :process_response
+  end
+end

data/lib/button/response.rb

@@ -0,0 +1,37 @@
+module Button
+  # Response is a simple proxy class for easy value unpacking from an API
+  # response.  It is constructed with a hash and proxies method calls on the
+  # instance down to keys in the underling hash.
+  #
+  # ## Usage
+  #
+  # response = Button::Response.new({ :a => 1, :b => "two" })
+  # puts response.a
+  # puts response.to_hash
+  #
+  class Response
+    def initialize(attrs)
+      @attrs = attrs || {}
+    end
+
+    def to_s
+      values = @attrs.reduce([]) do |acc, (name, value)|
+        acc + ["#{name}: #{value || 'nil'}"]
+      end.join(', ')
+
+      "Button::Response(#{values})"
+    end
+
+    def to_hash
+      @attrs
+    end
+
+    def method_missing(attr)
+      @attrs[attr] || super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @attrs.key?(method_name) || super
+    end
+  end
+end

data/lib/button/version.rb

@@ -0,0 +1,3 @@
+module Button
+  VERSION = '0.0.1'.freeze
+end

data/lib/button.rb

@@ -0,0 +1,2 @@
+require 'button/client'
+require 'button/version'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: button
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Button
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies: []
+description: Button is a contextual acquisition channel and closed-loop attribution
+  and affiliation system for mobile commerce.
+email:
+- support@usebutton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/button.rb
+- lib/button/client.rb
+- lib/button/errors.rb
+- lib/button/resources/orders.rb
+- lib/button/resources/resource.rb
+- lib/button/response.rb
+- lib/button/version.rb
+homepage: https://usebutton.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: ruby client for the Button Order API
+test_files: []