doshii 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c3d8430f4026ad2ccea4495e07ce6fb1163f7f
-  data.tar.gz: 5071726124ea7f93c3b91973aa3db9f111c29b8b
+  metadata.gz: fc12f5286fcf9522bdeee07839b37fa910c8039a
+  data.tar.gz: d5f313d0ae5599d608c9d8ed455042e700aea176
 SHA512:
-  metadata.gz: 1909698d9330f046cc2c39306a0973c7dab9d3beb8ced8dd5a9e931379c6e4536e790e2c8c55804a41e41196cfb5e4afee5360199cc98b1677525fd90f4f331c
-  data.tar.gz: 5451a22cd9299aa64819679ab2fbe6082b499fb8371c2094c574cc970b6b15ac98b42b572672ab9615d5d9fc1ff54de105d64253c73679d59a5b2414edbe80f0
+  metadata.gz: 0e08e6e96990623286bdd8447aac8a73ca2935f4b11c9262722ff86645773a1dcc4080e00c5bd1ffb05806b6a5131303d068b6df4ac1a0d2934eda01bc85bb1b
+  data.tar.gz: 227fb626f9d06096dc616b674068a2ecd2ab31966717ba9f8d7396ca1128fc26a403aadf53231a48fc70376e2824487f84ef7fd65fdf70f496549e24c909c66b

data/README.md

@@ -24,6 +24,18 @@ Or install it yourself as:
 
     $ gem install doshii
 
+
+rock'n'roll
+
+## Usage
+
+There are two ways to use Doshii:
+
+1. System wide shared configuration
+2. Per instance configuration
+
+### 1. System wide shared configuration
+
 Run this to create configuration file ```config/initializers/doshii.rb```:
 
     $ rails g doshii:install
@@ -34,16 +46,12 @@ Doshii.configure do |config|
   # you might want to set these values in environment files
   config.client_id     = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
   config.client_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
-  config.endpoint      = 'https://alphasandbox.doshii.co/partner/api'
+  config.subdomain     = 'alphasandbox'
   config.verify_ssl    = false
   config.version       = 'v1'
 end
 ```
 
-rock'n'roll
-
-## Usage
-
 **CHECKINS**
 
 DELETE /checkins/:checkinId
@@ -59,7 +67,7 @@ POST /checkins/:locationId
 Doshii.checkin.create :location_id do |params|
   params[:name]       = 'John Smith'
   params[:externalId] = 'ias2kk2'
-  params[:photoURL]   =  'http://example.com/profile.png'
+  params[:photoURL]   = 'http://example.com/profile.png'
 end
 ```
 or
@@ -150,6 +158,125 @@ GET /tables/:tableId
 Doshii.table.find :table_id
 ```
 
+### 2. Per instance configuration
+
+Pass configuration when defining new instance
+```ruby
+client = Doshii::Client.new(
+  client_id:     'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+  client_secret: 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy',
+  subdomain:     'alphasandbox', #default
+  verify_ssl:    false, #default
+  version:       'v1' #default
+)
+```
+
+**CHECKINS**
+
+DELETE /checkins/:checkinId
+```ruby
+client.delete_checkin :checkin_id
+```
+GET /checkins/:checkinId
+```ruby
+client.get_checkin :checkin_id
+```
+POST /checkins/:locationId
+```ruby
+client.create_checkin :location_id do |params|
+  params[:name]       = 'John Smith'
+  params[:externalId] = 'ias2kk2'
+  params[:photoURL]   = 'http://example.com/profile.png'
+end
+```
+or
+```ruby
+checkin_params = {
+  name: 'John Smith',
+  externalId: 'ias2kk2',
+  photoURL: 'http://example.com/profile.png'
+}
+client.create_checkin :location_id do |param|
+  params.merge!(checkin_params)
+end
+```
+POST /checkins/:checkinId/table
+```ruby
+client.allocate_table "#{:checkin_id}/table" do |params|
+  params[:name] = '3'
+end
+```
+
+**LOCATIONS**
+
+GET /locations
+```ruby
+client.list_locations
+```
+POST /locations
+```ruby
+client.create_location do |params|
+  params[:name]          = 'Chickens R Us'
+  params[:mobility]      = 'fixed'
+  params[:availability]  = 'closed'
+  params[:address_line1] = '608 St Kilda Rd'
+  # see the official api page for complete list of available params
+end
+```
+
+**ORDERS**
+
+GET /orders/:orderId
+```ruby
+client.get_order :order_id
+```
+POST /orders/:checkinId
+```ruby
+client.create_order :checkin_id do |params|
+  params[:status] = 'pending'
+  params[:items]  = [
+    {
+      name: 'Toasted Sourdough Bread & Eggs'
+      description: 'Just ye old classic'
+      # ...
+    }
+    # ...
+  ]
+  # see the official api page for complete list of available params
+end
+```
+PUT /orders/:orderId
+```ruby
+# sample - consumer wants to pay
+client.update_order :order_id do |params|
+  params[:tip]       = '0'
+  params[:status]    = 'ready to pay'
+  params[:updatedAt] = '2015-05-20T23:32:58.526Z'
+end
+# sample - payment has been processed and order is updated to paid
+client.update_order :order_id do |params|
+  params[:tip]           = '0'
+  params[:status]        = 'ready to pay'
+  params[:updatedAt]     = '2015-05-20T23:32:58.526Z'
+  params[:transactionId] = '123'
+  params[:invoiceId]     = '123'
+end
+```
+
+**PRODUCTS**
+
+GET /products/:locationId
+```ruby
+client.list_products :location_id
+```
+
+**TABLES**
+
+GET /tables/:tableId
+```ruby
+client.get_table :table_id
+```
+
 
 ## Development
 

data/doshii.gemspec

@@ -28,12 +28,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.7.0"
+  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "vcr", "~> 2.9.3"
   spec.add_development_dependency "webmock", "~> 1.21.0"
 
   spec.add_dependency "faraday", "~> 0.9.1"
   spec.add_dependency "faraday_middleware", "~> 0.10.0"
+  spec.add_dependency "hashie", "~> 3.4.0"
   spec.add_dependency "json", "~> 1.8.3"
 end

data/lib/doshii/client.rb

@@ -1,3 +1,9 @@
+require 'doshii/client/checkin'
+require 'doshii/client/location'
+require 'doshii/client/order'
+require 'doshii/client/product'
+require 'doshii/client/table'
+require 'doshii/connection'
 require 'doshii/resource'
 
 module Doshii
@@ -35,4 +41,30 @@ module Doshii
       Doshii.instance_variable_get(key)
     end
   end
+
+  class Client
+    include Connection
+    include Checkin
+    include Location
+    include Order
+    include Product
+    include Table
+
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options={})
+      merged_options = Doshii.options.merge(options)
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    private
+
+    def process_response(res)
+      return res if (res.status != 200 && res.body.blank?) || res.status == 404
+      return res.body.collect { |r| Doshii::Response[r] } if res.body.is_a? Array
+      body = Doshii::Response[res.body]
+    end
+  end
 end

data/lib/doshii/client/checkin.rb

@@ -0,0 +1,27 @@
+module Doshii
+  class Client
+    module Checkin
+      API_URL = 'checkins'
+
+      def allocate_table(checkin_id, query = {}, &block)
+        process_response(request :post, "#{API_URL}/#{checkin_id}", query, &block)
+      end
+
+      def create_checkin(location_id, query = {}, &block)
+        process_response(request :post, "#{API_URL}/#{location_id}", query, &block)
+      end
+
+      def delete_checkin(id)
+        process_response(request :delete, "#{API_URL}/#{id}")
+      end
+
+      def get_checkin(id)
+        process_response(request :get, "#{API_URL}/#{id}")
+      end
+
+      def update_checkin(id, query = {}, &block)
+        process_response(request :put, "#{API_URL}/#{id}", query, &block)
+      end
+    end
+  end
+end

data/lib/doshii/client/location.rb

@@ -0,0 +1,16 @@
+module Doshii
+  class Client
+    module Location
+      API_URL = 'locations'
+
+      def list_locations
+        process_response(request :get, API_URL)
+      end
+
+      def create_location(query = {}, &block)
+        process_response(request :post, API_URL, query, &block)
+      end
+    end
+  end
+end
+

data/lib/doshii/client/order.rb

@@ -0,0 +1,19 @@
+module Doshii
+  class Client
+    module Order
+      API_URL = 'orders'
+
+      def create_order(checkin_id, query = {}, &block)
+        process_response(request :post, "#{API_URL}/#{checkin_id}", query, &block)
+      end
+
+      def get_order(id)
+        process_response(request :get, "#{API_URL}/#{id}")
+      end
+
+      def update_order(id, query = {}, &block)
+        process_response(request :put, "#{API_URL}/#{id}", query, &block)
+      end
+    end
+  end
+end

data/lib/doshii/client/product.rb

@@ -0,0 +1,11 @@
+module Doshii
+  class Client
+    module Product
+      API_URL = 'products'
+
+      def list_products(location_id)
+        process_response(request :get, "#{API_URL}/#{location_id}")
+      end
+    end
+  end
+end

data/lib/doshii/client/table.rb

@@ -0,0 +1,11 @@
+module Doshii
+  class Client
+    module Table
+      API_URL = 'tables'
+
+      def get_table(id)
+        process_response(request :get, "#{API_URL}/#{id}")
+      end
+    end
+  end
+end

data/lib/doshii/configuration.rb

@@ -1,10 +1,10 @@
 module Doshii
   module Configuration
-    VALID_CONNECTION_KEYS = [:endpoint, :verify_ssl, :version].freeze
+    VALID_CONNECTION_KEYS = [:subdomain, :verify_ssl, :version].freeze
     VALID_OPTIONS_KEYS    = [:client_id, :client_secret].freeze
     VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
 
-    DEFAULT_ENDPOINT      = 'https://alphasandbox.doshii.co/partner/api'
+    DEFAULT_SUBDOMAIN     = 'alphasandbox'
     DEFAULT_VERIFY_SSL    = false
     DEFAULT_VERSION       = 'v1'
 
@@ -18,10 +18,10 @@ module Doshii
     end
 
     def reset
-      @endpoint      = DEFAULT_ENDPOINT
-      @verify_ssl    = DEFAULT_VERIFY_SSL
       @client_id     = DEFAULT_CLIENT_ID
       @client_secret = DEFAULT_CLIENT_SECRET
+      @subdomain     = DEFAULT_SUBDOMAIN
+      @verify_ssl    = DEFAULT_VERIFY_SSL
       @version       = DEFAULT_VERSION
     end
 

data/lib/doshii/connection.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'doshii/exceptions'
 require 'faraday'
 require 'faraday_middleware'
 
@@ -6,10 +7,12 @@ module Doshii
   module Connection
     protected
 
+    URL = "https://%{subdomain}.doshii.co/partner/api"
+
     def http_connection
       @http_connection ||=
-        Faraday.new("#{endpoint}/#{version}/") do |faraday|
-          faraday.response :logger
+        Faraday.new("#{URL % { subdomain: subdomain }}/#{version}/") do |faraday|
+          # faraday.response :logger
           faraday.adapter  Faraday.default_adapter
           faraday.use      Faraday::Response::ParseJson
 
@@ -22,10 +25,14 @@ module Doshii
     def request(method, url, query = {}, &block)
       body = Hash.new
       yield body if block_given?
-      http_connection.send(method) do |req|
+      response = http_connection.send(method) do |req|
         req.url url, query
         req.body = JSON.generate(body)
       end
+      raise Doshii::AuthenticationError.new(response.body) if response.status == 401
+      response
+    rescue Faraday::ConnectionFailed => e
+      raise Doshii::ConnectionError.new(e)
     end
 
     private

data/lib/doshii/exceptions.rb

@@ -0,0 +1,4 @@
+module Doshii
+  class ConnectionError < StandardError; end
+  class AuthenticationError < ConnectionError; end
+end

data/lib/doshii/resource.rb

@@ -1,4 +1,5 @@
 require 'doshii/connection'
+require 'doshii/response'
 
 module Doshii
   class Resource
@@ -16,24 +17,32 @@ module Doshii
     end
 
     def all
-      request :get, @url
+      process_response(request :get, @url)
     end
 
     def create(id = nil, query = {}, &block)
       url = id.nil? ? @url : "#{@url}/#{id}"
-      request :post, url, query, &block
+      process_response(request :post, url, query, &block)
     end
 
     def delete(id)
-      request :delete, "#{@url}/#{id}"
+      process_response(request :delete, "#{@url}/#{id}")
     end
 
     def find(id)
-      request :get, "#{@url}/#{id}"
+      process_response(request :get, "#{@url}/#{id}")
     end
 
     def update(id, query = {}, &block)
-      request :put, "#{@url}/#{id}", query, &block
+      process_response(request :put, "#{@url}/#{id}", query, &block)
+    end
+
+    private
+
+    def process_response(res)
+      return res if (res.status != 200 && res.body.blank?) || res.status == 404
+      return res.body.collect { |r| Doshii::Response[r] } if res.body.is_a? Array
+      body = Doshii::Response[res.body]
     end
   end
 end

data/lib/doshii/response.rb

@@ -0,0 +1,14 @@
+require 'hashie'
+
+module Doshii
+  class Response < Hash
+    include Hashie::Extensions::MethodAccess
+
+    def method_missing(name, *args, &block)
+      value = super
+      return value.collect { |v| Doshii::Response[v] } if value.is_a? Array
+      return Response[value] if value.is_a? Hash
+      value
+    end
+  end
+end

data/lib/doshii/version.rb

@@ -1,3 +1,3 @@
 module Doshii
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/generators/doshii/templates/doshii.rb

@@ -1,8 +1,8 @@
 Doshii.configure do |config|
   # you might want to set these values in environment files
-  config.client_id     = '369c27e8d884e0b54e56035b41eed4b07b0fc59091907418f0368ab643a4ad31'
-  config.client_secret = 'c0c0441e9bcc671dff9beb8e2a16fb43ed392f8c9a029dc8075cb71b1ac87e5f'
-  config.endpoint      = 'https://alphasandbox.doshii.co/partner/api'
+  config.client_id     = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+  config.client_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+  config.subdomain     = 'alphasandbox'
   config.verify_ssl    = false
   config.version       = 'v1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doshii
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Romel Campos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.7.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.7.0
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.7.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -140,9 +154,16 @@ files:
 - doshii.gemspec
 - lib/doshii.rb
 - lib/doshii/client.rb
+- lib/doshii/client/checkin.rb
+- lib/doshii/client/location.rb
+- lib/doshii/client/order.rb
+- lib/doshii/client/product.rb
+- lib/doshii/client/table.rb
 - lib/doshii/configuration.rb
 - lib/doshii/connection.rb
+- lib/doshii/exceptions.rb
 - lib/doshii/resource.rb
+- lib/doshii/response.rb
 - lib/doshii/version.rb
 - lib/generators/doshii/install_generator.rb
 - lib/generators/doshii/templates/doshii.rb
@@ -166,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Gem to wrap Doshii API