doshii 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eca56ca2714b029d9da78f34ddf852a02bfd3cb9
+  data.tar.gz: e7ee47054bf5cd141f402b10fa26ce6a086f03b7
+SHA512:
+  metadata.gz: 0714ab4409c9f0d727c5e0c2b3b9b95d96065a105a50c484f98a763a762bd21c1ef321929b482990fa4818443a00b2f6b8ac700b3f4bacd0e26550b0c649924f
+  data.tar.gz: aa11be65f5a6fda18e0d5f9c17778bbca5fcb0e79bbc0b7b0700949a7cf5ebbd667fd64e1f8ace906011acc74f472e057096c9aa23bb173929fb8f0b81f07db4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Romel Campos
+
+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,152 @@
+# Doshii
+
+A Doshii API wrapper gem. Refer to [alphasandbox.doshii.co](https://alphasandbox.doshii.co/docs/partner/api/) for Doshii's API official documentation.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doshii'
+```
+or
+```ruby
+gem 'doshii', :git => 'https://github.com/devrc-trise/doshii.git', :branch => 'develop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doshii
+
+Run this to create configuration file ```config/initializers/doshii.rb```:
+
+    $ rails g doshii:install
+
+Change ```config/initializers/doshii.rb``` as necessary. You might want to set values in system env or environment files to differentiate development, test and production details:
+```ruby
+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.verify_ssl    = false
+  config.version       = 'v1'
+end
+```
+
+rock'n'roll
+
+## Usage
+
+**CHECKINS**
+
+DELETE /checkins/:checkinId
+```ruby
+Doshii.checkin.delete :checkin_id
+```
+GET /checkins/:checkinId
+```ruby
+Doshii.checkin.find :checkin_id
+```
+POST /checkins/:locationId
+```ruby
+Doshii.checkin.create :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'
+}
+Doshii.checkin.create :location_id do |param|
+  params.merge!(checkin_params)
+end
+```
+
+**LOCATIONS**
+
+GET /locations
+```ruby
+Doshii.location.all
+```
+POST /locations
+```ruby
+Doshii.location.create 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
+Doshii.order.find :order_id
+```
+POST /orders/:checkinId
+```ruby
+Doshii.order.create :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
+Doshii.order.update :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
+Doshii.order.update :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
+Doshii.product.find :location_id
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/doshii/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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doshii"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doshii.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doshii/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doshii"
+  spec.version       = Doshii::VERSION
+  spec.authors       = ["Romel Campos"]
+  spec.email         = ["rcoolah@gmail.com"]
+
+  spec.summary       = %q{Gem to wrap Doshii API}
+  spec.description   = %q{Gem to wrap Doshii API}
+  spec.homepage      = "https://github.com/devrc-trise/doshii"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 "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 "json", "~> 1.8.3"
+end

data/lib/doshii.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+require 'doshii/version'
+require 'doshii/configuration'
+require 'doshii/client'
+
+module Doshii
+  extend Configuration
+end

data/lib/doshii/client.rb

@@ -0,0 +1,34 @@
+require 'doshii/resource'
+
+module Doshii
+  class << self
+    def checkin
+      resource 'checkins'
+    end
+
+    def location
+      resource 'locations'
+    end
+
+    def order
+      resource 'orders'
+    end
+
+    def product
+      resource 'products'
+    end
+
+    def options
+      Hash[*Configuration::VALID_CONFIG_KEYS.map { |key| [key, value(key)] }.flatten]
+    end
+
+    def resource(url)
+      Doshii::Resource.new url, options
+    end
+
+    def value(key)
+      key = "@#{key.to_s}".to_sym
+      Doshii.instance_variable_get(key)
+    end
+  end
+end

data/lib/doshii/configuration.rb

@@ -0,0 +1,36 @@
+module Doshii
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :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_VERIFY_SSL    = false
+    DEFAULT_VERSION       = 'v1'
+
+    DEFAULT_CLIENT_ID     = '369c27e8d884e0b54e56035b41eed4b07b0fc59091907418f0368ab643a4ad31'
+    DEFAULT_CLIENT_SECRET = 'c0c0441e9bcc671dff9beb8e2a16fb43ed392f8c9a029dc8075cb71b1ac87e5f'
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      @endpoint      = DEFAULT_ENDPOINT
+      @verify_ssl    = DEFAULT_VERIFY_SSL
+      @client_id     = DEFAULT_CLIENT_ID
+      @client_secret = DEFAULT_CLIENT_SECRET
+      @version       = DEFAULT_VERSION
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[*VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten]
+    end
+  end
+end

data/lib/doshii/connection.rb

@@ -0,0 +1,38 @@
+require 'base64'
+require 'faraday'
+require 'faraday_middleware'
+
+module Doshii
+  module Connection
+    protected
+
+    def http_connection
+      @http_connection ||=
+        Faraday.new("#{endpoint}/#{version}/") do |faraday|
+          faraday.response :logger
+          faraday.adapter  Faraday.default_adapter
+          faraday.use      Faraday::Response::ParseJson
+
+          faraday.headers['Authorization'] = "Basic #{base64_encoded_key}"
+          faraday.headers['Content-Type']  = 'application/json'
+          faraday.ssl['verify']            = verify_ssl
+        end
+    end
+
+    def request(method, url, query = {}, &block)
+      body = Hash.new
+      yield body if block_given?
+      http_connection.send(method) do |req|
+        req.url url, query
+        req.body = JSON.generate(body)
+      end
+    end
+
+    private
+
+    def base64_encoded_key
+      key = "#{client_id}:#{client_secret}"
+      Base64.urlsafe_encode64 key
+    end
+  end
+end

data/lib/doshii/resource.rb

@@ -0,0 +1,39 @@
+require 'doshii/connection'
+
+module Doshii
+  class Resource
+    include Connection
+
+    attr_writer   :url
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(url, options = {})
+      @url = url
+      merged_options = Doshii.options.merge(options)
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def all
+      request :get, @url
+    end
+
+    def create(id = nil, query = {}, &block)
+      url = id.nil? ? @url : "#{@url}/#{id}"
+      request :post, url, query, &block
+    end
+
+    def delete(id)
+      request :delete, "#{@url}/#{id}"
+    end
+
+    def find(id)
+      request :get, "#{@url}/#{id}"
+    end
+
+    def update(id, query = {}, &block)
+      request :put, "#{@url}/#{id}", query, &block
+    end
+  end
+end

data/lib/doshii/version.rb

@@ -0,0 +1,3 @@
+module Doshii
+  VERSION = '0.1.0'
+end

data/lib/generators/doshii/install_generator.rb

@@ -0,0 +1,9 @@
+module Doshii
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_initializer_file
+      copy_file 'doshii.rb', 'config/initializers/doshii.rb'
+    end
+  end
+end

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

@@ -0,0 +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.verify_ssl    = false
+  config.version       = 'v1'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: doshii
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Romel Campos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Gem to wrap Doshii API
+email:
+- rcoolah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doshii.gemspec
+- lib/doshii.rb
+- lib/doshii/client.rb
+- lib/doshii/configuration.rb
+- lib/doshii/connection.rb
+- lib/doshii/resource.rb
+- lib/doshii/version.rb
+- lib/generators/doshii/install_generator.rb
+- lib/generators/doshii/templates/doshii.rb
+homepage: https://github.com/devrc-trise/doshii
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gem to wrap Doshii API
+test_files: []