gecko-ruby 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3e9fd6fed6c04a1519102f2148126d4afce428a
+  data.tar.gz: 6f9df328f522933a00cc2153b1bdc0ddf3b21478
+SHA512:
+  metadata.gz: f2fd067297069ac22a4f11fe40690317c217b121c2eed07d286c386702c98105ba1546a30cc0a5ab9eb060742b159eea01bdfba6d314775f59968bd079d37039
+  data.tar.gz: 11fe376aeafdbbce26989aad6f7ff9d604bdf89b0e295907f0baf07e6baaf07a07d54e29f1f99d1db24982447afdcc210e5d04893a8d05d12ede80a42200a0df

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.env
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+bin
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,9 @@
+# I personally disagree with this default and much rather outdented keywords
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+IndentHash:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+## Unreleased
+
+- Renamed gem so we can publish it on RubyGems.org
+- Add `Gecko::Record::TaxType`
+- Add `Gecko::Record::PurchaseOrder` and `Gecko::Record::PurchaseOrderLineItem`
+- Add `Gecko::Record::Invoice` & `Gecko::Record::InvoiceLineItem`
+- Change pagination numbers to fetch from the headers instead of the metadata object
+- Add `Gecko::Record::Contact`
+- Add `Gecko::Record::User`
+- Add `Gecko::Record::Location`
+- Remove `@client.Account.build`
+- TradeGecko API updates - Variant prices + locations now returned as arrays
+
+## 0.0.3 (2014-03-27)
+
+- Add `record.save`
+- Parse server-side validation errors
+- Add support for readonly attributes in serialization
+- Basic serialization support via `as_json` and `serializable_hash` helpers
+
+## 0.0.2 (2014-03-08)
+
+- AS::Notifications for API calls
+- Add `@client.Record.build(attributes)`
+- Add `Record#persisted?`
+- Implement a custom User-Agent
+
+## 0.0.1 (2014-03-07)
+
+- Add `rake console`
+- Verify an ID is passed to the find methods
+- Custom `RecordNotFound` errors
+- Add current account query method `@client.Account.current`
+- Add `Gecko::Record::Account`
+- Custom `record#inspect`
+- Adds a basic IdentityMap and related query methods
+- Basic query methods for Records `client.Record.find(1)`, `client.Record.where()`
+- Adds `@client.Record` record adapter accessors
+- Add `belongs_to`/`has_many` support to `Gecko::Record` types
+- Defines the framework for Gecko::Record::XXXX record classes
+- Gecko::Client wraps around TradeGecko Authentication

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gecko.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TradeGecko Pte Ltd.
+
+MIT License
+
+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,144 @@
+# TradeGecko RubyGem [![Build Status](https://travis-ci.org/tradegecko/gecko.png)](https://travis-ci.org/tradegecko/gecko) [![Code Climate](https://codeclimate.com/github/tradegecko/gecko.png)](https://codeclimate.com/github/tradegecko/gecko)
+The official TradeGecko API RubyGem
+
+## Introduction
+
+This library provides a Ruby interface to publicly available (beta) API for TradeGecko.
+
+If you are unfamiliar with the TradeGecko API, you can read the documentation located at [http://developer.tradegecko.com](http://developer.tradegecko.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gecko-ruby', '~> 0.0.4'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gecko-ruby
+
+## Basic Usage
+
+```ruby
+client = Gecko::Client.new(CLIENT_ID, CLIENT_SECRET)
+client.access_token = existing_access_token
+
+products = client.Product.where(q: "Gecko")
+#=> [<Gecko::Record::Product id=1 name="Geckotron">, <Gecko::Record::Product id=3 name="Green Gecko">]
+```
+
+## Finding Records
+
+#### Basic finders
+```ruby
+client.Product.find(123)
+#=> <Gecko::Record::Product id=123 name="Geckotron">
+client.Product.find_many(123, 124)
+#=> [<Gecko::Record::Product id=123 name="Geckotron">, <Gecko::Record::Product id=124 name="Salamander">
+client.Product.where(ids: [123, 124])
+#=> [<Gecko::Record::Product id=123 name="Geckotron">, <Gecko::Record::Product id=124 name="Salamander">
+```
+
+#### Identity Map
+
+The Gecko gem ships with a basic identity map
+
+```ruby
+client.Product.find(123)
+# Makes an API request
+
+client.Product.find(123)
+# Returned from identity map on second request, no API request
+
+client.Product.fetch(123)
+# Does not use identity map and makes request regardless
+
+client.Product.find_many([123, 124])
+# Will return 123 from memory and make request for 124
+
+client.Product.where(ids: [123, 124])
+# Does not use identity map and makes request regardless
+```
+
+## Building Records
+
+```ruby
+geckobot = client.Product.build(name: "Geckobot", product_type: "Robot")
+#=> <Gecko::Record::Product id=nil name="Geckobot" product_type: "Robot">
+geckobot.persisted?
+#=> false
+```
+
+## Persisting Records
+
+#### Create Record
+
+```ruby
+geckobot = client.Product.build(name: "Geckobot", product_type: "Robot")
+#=> <Gecko::Record::Product id=nil name="Geckobot" product_type: "Robot">
+geckobot.persisted?
+#=> false
+geckobot.save # Persists to API
+#=> true
+geckobot
+#=> <Gecko::Record::Product id=124 name="Geckobot" product_type: "Robot">
+```
+
+#### Update Record
+
+```ruby
+geckobot = client.Product.find(124)
+#=> <Gecko::Record::Product id=124 name="Geckobot" product_type: "Robot">
+geckobot.persisted?
+#=> true
+geckobot.product_type = "Robo-boogie"
+geckobot.save # Persists to API
+#=> true
+geckobot
+#=> <Gecko::Record::Product id=124 name="Geckobot" product_type: "Robo-boogie">
+```
+
+#### Validations
+
+```ruby
+geckobot = client.Product.find(124)
+#=> <Gecko::Record::Product id=124 name="Geckobot" product_type: "Robot">
+geckobot.persisted?
+#=> true
+geckobot.name = nil
+geckobot.save # Attempts to persist to API
+#=> false
+geckobot.valid?
+#=> false
+geckobot.errors
+#=> #<Gecko::Errors:0x007ff46d961810 @base=#<Gecko::Record::Base:0x007ff46d96aaa0 id: 124, name: nil>, @messages={:name=>["can't be blank"]}>
+```
+
+## Instrumentation
+
+The Gecko gem supports instrumentation via AS::Notifications.
+You can subscribe to API calls by subscribing to `'request.gecko'` notifications
+
+```ruby
+ActiveSupport::Notifications.subscribe('request.gecko') do |name, start, finish, id, payload|
+  # Do Something
+end
+```
+
+## TODO
+- Deleting records
+- Complete record collection
+- Handle more API Errors
+- Clean up Access Token management
+
+## Contributing
+
+1. Fork it ( http://github.com/[my-github-username]/gecko/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end
+
+desc "Open an irb session with Gecko"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'gecko-ruby'
+  ARGV.clear
+  IRB.start
+end

data/gecko-ruby.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gecko/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gecko-ruby'
+  spec.version = Gecko::VERSION
+  spec.authors = ["Bradley Priest"]
+  spec.email = ['bradley@tradegecko.com']
+  spec.description = %q{A Ruby interface to the TradeGecko API.}
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/tradegecko/gecko/'
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "thor"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "oauth2"
+  spec.add_dependency "virtus"
+  spec.add_dependency "activesupport"
+end

data/generate.thor

@@ -0,0 +1,81 @@
+require 'active_support/inflector'
+class Generate < Thor
+  include Thor::Actions
+
+  desc "model MODEL_NAME", "generates a new model"
+  def model(model_name)
+    @model_name = model_name
+    @file_name  = model_name.underscore
+    @plural     = ask "What is the underscore plural of #{@model_name}? (#{@file_name}s):"
+    @plural     = @plural.to_s.length > 0 ? @plural : @file_name + "s"
+    create_file "lib/gecko/record/#{@file_name}.rb", model_template
+    create_file "test/record/#{@file_name}_adapter_test.rb", test_adapter_template
+    create_file "test/record/#{@file_name}_test.rb", test_template
+    insert_into_file("lib/gecko/client.rb", "    record :#{@model_name}\n", before: "\n    # Return OAuth client")
+    append_to_file("lib/gecko.rb", "require 'gecko/record/#{@file_name}'")
+  end
+
+private
+  def default_plural?
+    @plural == @file_name + "s"
+  end
+
+  def model_template
+%{require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class #{@model_name} < Base
+      # belongs_to :widget
+      # has_many :wodgets
+      # attribute :name, String
+    end
+
+    class #{@model_name}Adapter < BaseAdapter
+      #{"def plural_name
+        '#{@plural}'
+      end" if !default_plural?}
+    end
+  end
+end
+}
+  end
+
+  def test_template
+%{require 'test_helper'
+
+class Gecko::#{@model_name}Test < Minitest::Test
+  include VCRHelper
+  include SharedRecordExamples
+
+  let(:plural_name)   { "#{@plural}" }
+  let(:record_class)  { Gecko::Record::#{@model_name} }
+
+  def setup
+    @json   = load_vcr_hash("#{@plural}", "#{@plural}").first
+    @record = record_class.new(client, @json)
+  end
+
+  def test_initializes_record
+    assert_instance_of(Gecko::Record::#{@model_name}, @record)
+  end
+end}
+  end
+
+  def test_adapter_template
+%{require 'test_helper'
+
+class Gecko::Record::#{@model_name}AdapterTest < Minitest::Test
+  include TestingAdapter
+  include SharedAdapterExamples
+
+  let(:adapter)       { @client.#{@model_name} }
+  let(:plural_name)   { "#{@plural}" }
+  let(:record_class)  { Gecko::Record::#{@model_name} }
+
+  def test_initializes_adapter
+    assert_instance_of(Gecko::Record::#{@model_name}Adapter, @client.#{@model_name})
+  end
+end}
+  end
+end

data/lib/gecko-ruby.rb

@@ -0,0 +1 @@
+require 'gecko'

data/lib/gecko.rb

@@ -0,0 +1,31 @@
+require 'virtus'
+require 'active_support/inflector'
+require 'active_support/notifications'
+require 'oauth2'
+
+require 'gecko/client'
+
+# Include models
+require 'gecko/record/base'
+require 'gecko/record/base_adapter'
+require 'gecko/record/exceptions'
+
+require 'gecko/record/account'
+require 'gecko/record/address'
+require 'gecko/record/company'
+require 'gecko/record/contact'
+require 'gecko/record/currency'
+require 'gecko/record/order'
+require 'gecko/record/order_line_item'
+require 'gecko/record/fulfillment'
+require 'gecko/record/fulfillment_line_item'
+require 'gecko/record/invoice'
+require 'gecko/record/invoice_line_item'
+require 'gecko/record/product'
+require 'gecko/record/variant'
+require 'gecko/record/image'
+require 'gecko/record/location'
+require 'gecko/record/user'
+require 'gecko/record/purchase_order'
+require 'gecko/record/purchase_order_line_item'
+require 'gecko/record/tax_type'

data/lib/gecko/client.rb

@@ -0,0 +1,132 @@
+require 'faraday'
+require 'oauth2/version'
+require 'gecko/version'
+require 'gecko/helpers/record_helper'
+
+module Gecko
+  # The Gecko::Client class
+  class Client
+    extend Helpers::RecordHelper
+
+    record :Account
+    record :Currency
+    record :Location
+    record :User
+
+    record :Address
+    record :Company
+    record :Contact
+
+    record :Order
+    record :OrderLineItem
+    record :Fulfillment
+    record :FulfillmentLineItem
+    record :Invoice
+    record :InvoiceLineItem
+
+    record :Product
+    record :Variant
+    record :Image
+    record :PurchaseOrder
+    record :PurchaseOrderLineItem
+    record :TaxType
+
+    # Return OAuth client
+    #
+    # @return [OAuth2::Client]
+    #
+    # @api private
+    attr_reader :oauth_client
+
+    # Access the OAuth AccessToken for this client
+    #
+    # @return [OAuth2::AccessToken]
+    #
+    # @api public
+    attr_accessor :access_token
+
+    # Initialize a new Gecko client object with an instantiated OAuth2::Client
+    #
+    # @param [String] client_id
+    # @param [String] client_secret
+    # @param [#to_hash] extra options hash to pass to the OAuth2::Client
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(client_id, client_secret, options={})
+      setup_oauth_client(client_id, client_secret, options)
+    end
+
+    # Authorize client from existing access and refresh token
+    #
+    # @example
+    #   client.authorize_from_existing("ABC", "DEF", "1393982563")
+    #
+    # @param [String] access_token
+    # @param [String] refresh_token
+    # @param [String] expires_at
+    #
+    # @return [OAuth2::AccessToken]
+    #
+    # @api public
+    def authorize_from_existing(access_token, refresh_token, expires_at)
+      @access_token = OAuth2::AccessToken.new(oauth_client, access_token, {
+        refresh_token: refresh_token,
+        expires_at:    expires_at
+      })
+    end
+
+    # Authorize client by fetching a new access_token via refresh token
+    #
+    # @example
+    #   client.authorize_from_refresh_token("DEF")
+    #
+    # @param [String] refresh_token
+    #
+    # @return [OAuth2::AccessToken]
+    #
+    # @api public
+    def authorize_from_refresh_token(refresh_token)
+      @access_token = oauth_client.get_token({
+        client_id:     oauth_client.id,
+        client_secret: oauth_client.secret,
+        refresh_token: refresh_token,
+        grant_type:    'refresh_token'
+      })
+    end
+
+    # Fetch the adapter for a specified Gecko::Record class
+    #
+    # @param [String] klass_name Gecko::Record subclass name
+    #
+    # @return [Gecko::Record::BaseAdapter]
+    #
+    # @api private
+    def adapter_for(klass_name)
+      self.public_send(klass_name.to_sym)
+    end
+
+  private
+
+    def setup_oauth_client(client_id, client_secret, options)
+      defaults = {
+        site:          'https://api.tradegecko.com',
+        authorize_url: 'https://go.tradegecko.com/oauth/authorize',
+        connection_opts: {
+          headers:     default_headers
+        }
+      }
+      @oauth_client = OAuth2::Client.new(client_id, client_secret, defaults.merge(options))
+    end
+
+    def default_headers
+      {
+        'User-Agent' => ["Gecko/#{Gecko::VERSION}",
+                         "OAuth2/#{OAuth2::Version.to_s}",
+                         "Faraday/#{Faraday::VERSION}",
+                         "Ruby/#{RUBY_VERSION}"].join(' ')
+      }
+    end
+  end
+end