omnivore-io 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45be8df81ea56b02b94b19fd0e72bb1586de33b2
+  data.tar.gz: d5234db929409f4bd3c4ddeebb0837b8f6327ca2
+SHA512:
+  metadata.gz: 2a063d4d8a67e70412e63271f73f2b6bd4c6bb816d3cad1eaed73f4fc58dd7c0b178cf419c88bb2f1017ca0bcf318bcdbf37f4757007c5edfe7588d3f9794518
+  data.tar.gz: 03c7a081b78b49833ffd6d5acde2e5e5fab46a97c5dcfb4b47984d9134073e5fb2c9345083a31d79d79430bbedaa85a9ece9495bf9ab131d9525cdeb0a878943

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.ruby-version
+.ruby-gemset
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in omnivore-io.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Amvse, Inc.
+
+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,28 @@
+Omnivore.io Ruby Client
+=======================
+
+The Omnivore.io Ruby Client is used to interact with the [Omnivore API](https://panel.omnivore.io/docs/api) from Ruby.
+
+Usage
+-----
+
+Start by creating a connection to Omnivore with your credentials:
+
+```ruby
+require 'omnivore-io'
+$omnivore_io = OmnivoreIO::API.new(api_key: "API_KEY_HERE")
+```
+
+Now you can make requests to the API.
+
+Requests
+--------
+
+*TODO*
+
+Meta
+----
+
+Based heavily on [heroku.rb](https://github.com/heroku/heroku.rb), originally authored by geemus (Wesley Beary) and Pedro Belo. Thanks, Heroku!
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/lib/omnivore-io.rb

@@ -0,0 +1 @@
+require(File.join(File.dirname(__FILE__), "omnivore-io", "api"))

data/lib/omnivore-io/api.rb

@@ -0,0 +1,105 @@
+require 'rest_client'
+require 'json'
+
+__LIB_DIR__ = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+unless $LOAD_PATH.include?(__LIB_DIR__)
+  $LOAD_PATH.unshift(__LIB_DIR__)
+end
+
+require "omnivore-io/api/errors"
+require "omnivore-io/api/version"
+
+module OmnivoreIO
+  module OmnivoreObject
+    
+    def self.included base
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      attr_accessor :_json_attributes 
+      
+      def json_attr_accessor(*attributes)
+        self._json_attributes = attributes
+        attributes.each do |attribute|
+          attr_accessor attribute
+        end
+      end
+    end
+    
+    module InstanceMethods
+      
+      def as_json(options={})
+        json = {}
+        self.class._json_attributes.each do |attr|
+          val = self.send attr
+          json[attr] = val
+        end
+        json
+      end
+      
+      def merge!(object)
+        self.class._json_attributes.each do |attr|
+          if object.respond_to?(attr)
+            if val = object.send(attr)
+              self.send "#{attr}=".to_sym, val
+            end
+          end
+        end
+      end
+      
+    end
+
+  end
+  
+  class API
+
+    HEADERS = {
+      :content_type => :json,
+      :accept => :json,
+      :'Api-Key' => 'API_KEY_HERE'
+    }
+
+    OPTIONS = {
+      :host => 'https://api.omnivore.io/',
+      :api_version => '0.1'
+    }
+
+    def initialize(options={})
+      options = OPTIONS.merge(options)
+
+      @api_key = options.delete(:api_key) || ENV['OMNIVORE_IO_API_KEY']
+    end
+
+    def api_key
+      @api_key
+    end
+
+    def request(method, endpoint, query={}, headers={})
+      headers.merge!({ 'content_type' => :json, 'Api-Key' => self.api_key })
+      response = case method
+      when :get
+        url = "#{OPTIONS[:host]}#{OPTIONS[:api_version]}#{endpoint}"
+        if query.keys.length
+          url << "?"
+          url << URI.encode_www_form(query)
+        end
+        RestClient.get url, headers
+      when :post
+        url = "#{OPTIONS[:host]}#{OPTIONS[:api_version]}#{endpoint}"
+        payload = query.as_json.to_json
+        RestClient::Request.execute(method: :post, url: url, payload: payload, headers: headers)
+      end
+      # TODO: handle errors
+      JSON.parse(response.to_str)
+    end
+
+  end
+end
+
+require "omnivore-io/api/location"
+require "omnivore-io/api/menu_item"
+require "omnivore-io/api/modifier"
+require "omnivore-io/api/order_type"
+require "omnivore-io/api/ticket"

data/lib/omnivore-io/api/errors.rb

@@ -0,0 +1,28 @@
+module OmnivoreIO
+  class API
+    module Errors
+      class Error < StandardError; end
+
+      class ErrorWithResponse < Error
+        attr_reader :response
+
+        def initialize(message, response)
+          message = message << "\nbody: #{response.body.inspect}"
+          super message
+          @response = response
+        end
+      end
+
+      class Unauthorized < ErrorWithResponse; end
+      class VerificationRequired < ErrorWithResponse; end
+      class Forbidden < ErrorWithResponse; end
+      class NotFound < ErrorWithResponse; end
+      class Timeout < ErrorWithResponse; end
+      class Locked < ErrorWithResponse; end
+      class RateLimitExceeded < ErrorWithResponse; end
+      class RequestFailed < ErrorWithResponse; end
+      class NilApp < ErrorWithResponse; end
+
+    end
+  end
+end

data/lib/omnivore-io/api/location.rb

@@ -0,0 +1,57 @@
+module OmnivoreIO
+  class Location
+    include OmnivoreObject
+    
+    attr_accessor :client
+    json_attr_accessor :id, :address, :name, :phone, :website, :status
+    
+    def initialize(client, attributes={})
+      self.client = client
+      attributes.each do |key, value|
+        if self.respond_to? "#{key}=".to_sym
+          self.send "#{key}=".to_sym, value
+        end
+      end
+    end
+    
+    def menu_items(options={})
+      client.get_menu_items(self.id, options)
+    end
+    
+    def order_types(options={})
+      client.get_order_types(self.id, options)
+    end
+    
+    def tickets(options={})
+      client.get_tickets(self.id, options)
+    end
+    
+    def online?
+      self.status == 'online'
+    end
+    
+  end
+  
+  class API
+
+    def get_locations(options={})
+      response = request(
+        :get,
+        '/locations',
+        options
+      )
+      (response['_embedded']['locations'] || []).map do |location_hash|
+        OmnivoreIO::Location.new self, location_hash
+      end
+    end
+    
+    def get_location(location_id)
+      response = request(
+        :get,
+        "/locations/#{location_id}"
+      )
+      OmnivoreIO::Location.new self, response
+    end
+
+  end
+end

data/lib/omnivore-io/api/menu_item.rb

@@ -0,0 +1,35 @@
+module OmnivoreIO
+  class MenuItem
+    include OmnivoreObject
+    
+    attr_accessor :client
+    json_attr_accessor :id, :location_id, :name, :price, :price_levels,
+      :in_stock, :modifier_groups_count
+    
+    def initialize(client, attributes={})
+      self.client = client
+      attributes.each do |key, value|
+        if self.respond_to? "#{key}=".to_sym
+          self.send "#{key}=".to_sym, value
+        end
+      end
+    end
+    
+  end
+  
+  class API
+
+    def get_menu_items(location_id, options={})
+      response = request(:get, "/locations/#{location_id}/menu/items", options)
+      (response['_embedded']['menu_items'] || []).map do |menu_item_hash|
+        OmnivoreIO::MenuItem.new self, menu_item_hash.merge(location_id: location_id)
+      end
+    end
+    
+    def get_menu_item(location_id, menu_item_id)
+      response = request(:get, "/locations/#{location_id}/menu/items/#{menu_item_id}")
+      OmnivoreIO::MenuItem.new self, response.merge(location_id: location_id)
+    end
+
+  end
+end

data/lib/omnivore-io/api/modifier.rb

@@ -0,0 +1,35 @@
+module OmnivoreIO
+  class Modifier
+    include OmnivoreObject
+    
+    attr_accessor :client
+    json_attr_accessor :id, :name, :price, :price_levels,
+      :price_per_unit
+    
+    def initialize(client, attributes={})
+      self.client = client
+      attributes.each do |key, value|
+        if self.respond_to? "#{key}=".to_sym
+          self.send "#{key}=".to_sym, value
+        end
+      end
+    end
+    
+  end
+  
+  class API
+
+    def get_modifiers(location_id, options={})
+      response = request(:get, "/locations/#{location_id}/menu/modifiers", options)
+      (response['_embedded']['modifiers'] || []).map do |modifier_hash|
+        OmnivoreIO::Modifier.new self, modifier_hash.merge(location_id: location_id)
+      end
+    end
+    
+    def get_modifier(location_id, modifier_id)
+      response = request(:get, "/locations/#{location_id}/menu/modifiers/#{modifier_id}")
+      OmnivoreIO::Modifier.new self, response.merge(location_id: location_id)
+    end
+
+  end
+end

data/lib/omnivore-io/api/order_type.rb

@@ -0,0 +1,29 @@
+module OmnivoreIO
+  class OrderType
+    include OmnivoreObject
+    
+    attr_accessor :client
+    json_attr_accessor :id, :location_id, :available, :name
+    
+    def initialize(client, attributes={})
+      self.client = client
+      attributes.each do |key, value|
+        if self.respond_to? "#{key}=".to_sym
+          self.send "#{key}=".to_sym, value
+        end
+      end
+    end
+    
+  end
+  
+  class API
+
+    def get_order_types(location_id, options={})
+      response = request(:get, "/locations/#{location_id}/order_types", options)
+      (response['_embedded']['order_types'] || []).map do |order_type_hash|
+        OmnivoreIO::OrderType.new self, order_type_hash.merge(location_id: location_id)
+      end
+    end
+
+  end
+end

data/lib/omnivore-io/api/ticket.rb

@@ -0,0 +1,63 @@
+module OmnivoreIO
+  class Ticket
+    include OmnivoreObject
+    
+    attr_accessor :client, :items
+    json_attr_accessor :id, :location_id, :auto_send, :closed_at,
+      :guest_count, :name, :open, :opened_at, :ticket_number, :totals, :employee, :order_type, :revenue_center
+    
+    def initialize(client, attributes={})
+      self.client = client
+      self.items = []
+      attributes.each do |key, value|
+        if self.respond_to? "#{key}=".to_sym
+          self.send "#{key}=".to_sym, value
+        end
+      end
+    end
+    
+    def open!
+      payload = {
+        "employee" => self.employee,
+        "order_type" => self.order_type,
+        "revenue_center" => self.revenue_center,
+        "guest_count" => self.guest_count,
+        "name" => self.name,
+        "auto_send" => self.auto_send
+      }
+      self.merge! self.client.open_ticket(self.location_id, payload)
+    end
+    
+  end
+  
+  class API
+
+    def get_tickets(location_id, options={})
+      response = request(:get, "/locations/#{location_id}/tickets", options)
+      (response['_embedded']['tickets'] || []).map do |ticket_hash|
+        OmnivoreIO::Ticket.new self, ticket_hash.merge(location_id: location_id)
+      end
+    end
+    
+    def get_ticket(location_id, ticket_id)
+      response = request(:get, "/locations/#{location_id}/tickets/#{ticket_id}")
+      OmnivoreIO::Ticket.new self, response.merge(location_id: location_id)
+    end
+    
+    def open_ticket(location_id, ticket_json)
+      response = request(:post, "/locations/#{location_id}/tickets", ticket_json)
+      OmnivoreIO::Ticket.new self, response.merge(location_id: location_id)
+    end
+    
+    def add_menu_item_to_ticket(location_id, ticket_id, payload_json)
+      response = request(:post, "/locations/#{location_id}/tickets/#{ticket_id}/items", payload_json)
+      OmnivoreIO::Ticket.new self, response.merge(location_id: location_id)
+    end
+    
+    def add_payment_to_ticket(location_id, ticket_id, payload_json)
+      response = request(:post, "/locations/#{location_id}/tickets/#{ticket_id}/payments", payload_json)
+      response
+    end
+
+  end
+end

data/lib/omnivore-io/api/version.rb

@@ -0,0 +1,5 @@
+module OmnivoreIO
+  class API
+    VERSION = "0.0.1"
+  end
+end

data/omnivore-io.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omnivore-io/api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omnivore-io"
+  s.version     = OmnivoreIO::API::VERSION
+  s.authors     = ["Zane Shannon"]
+  s.email       = ["zcs@amvse.com"]
+  s.homepage    = "http://github.com/amvse/omnivore-io"
+  s.license     = 'MIT'
+  s.summary     = %q{Ruby Client for the Omnivore.io API}
+  s.description = %q{Ruby Client for the Omnivore.io API}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'rest_client'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: omnivore-io
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zane Shannon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Client for the Omnivore.io API
+email:
+- zcs@amvse.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/omnivore-io.rb
+- lib/omnivore-io/api.rb
+- lib/omnivore-io/api/errors.rb
+- lib/omnivore-io/api/location.rb
+- lib/omnivore-io/api/menu_item.rb
+- lib/omnivore-io/api/modifier.rb
+- lib/omnivore-io/api/order_type.rb
+- lib/omnivore-io/api/ticket.rb
+- lib/omnivore-io/api/version.rb
+- omnivore-io.gemspec
+homepage: http://github.com/amvse/omnivore-io
+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: Ruby Client for the Omnivore.io API
+test_files: []