Initial build

Author: Will Myers

.gitignore

@@ -1,50 +1,2 @@
+Gemfile.lock
 *.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.0

CHANGELOG.md

@@ -0,0 +1,2 @@
+1.0.0 August 11, 2016
+  - Initial Release

Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'test-unit'
+  gem 'webmock'
+end

README.md

@@ -1,2 +1,125 @@
-# button-client-ruby
-ruby client for the Button Order API 
+# 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.
+
+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`

Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end

bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require "#{File.expand_path('../../lib', __FILE__)}/button.rb"
+
+IRB.start

button.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'button'
+
+Gem::Specification.new do |spec|
+  spec.name = 'button'
+  spec.version = Button::VERSION
+  spec.authors = ['Button']
+  spec.email = ['support@usebutton.com']
+  spec.summary = 'ruby client for the Button Order API'
+  spec.description = 'Button is a contextual acquisition channel and closed-loop attribution and affiliation system for mobile commerce.'
+  spec.homepage = 'https://usebutton.com'
+
+  spec.files = Dir.glob('lib/**/*') + ['LICENSE', 'README.md', 'CHANGELOG.md']
+  spec.license = 'MIT'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+end

lib/button.rb

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

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