singleplatform 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cec3922463afab967e8fd8cb232e18b38b03a5b
+  data.tar.gz: 4246d0e5f2c24643433faa462f324be89772c144
+SHA512:
+  metadata.gz: 28a77401efa0875e85a135be5f7742f90df1a873fe2774028af577a3e658eaae98c017998f358521aaed54351b37f9a4047579a5cb8bb8e08016bf425f557cde
+  data.tar.gz: 8a331be44e7e42b30068d08bddac1c004e71dce901a5d2b3f8ce3b878258cd2c13115ad7efb990665f7a094226d79ea102bddc3712fe4042a15d53b95a72be91

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.env
+singleplatform-0.1.0.gem

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'bundler'
+gem 'httparty'
+gem 'hashie'

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.1.1)
+    hashie (3.4.3)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.5.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  dotenv
+  hashie
+  httparty
+
+RUBY VERSION
+   ruby 2.2.2p95
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,84 @@
+# SinglePlatform API Ruby Client
+This is a wrapper for accessing SinglePlatform's API. Please see [SinglePlatform's official API documentation](http://docs.singleplatform.com/spv3/) for information on obtaining API credentials.
+
+## Installation
+```
+gem install singleplatform
+```
+
+Or add this to your applications Gemfile:
+```
+gem 'singleplatform'
+```
+
+And then run:
+
+```
+bundle install
+```
+
+## Usage
+### Initializing an API Client
+The gem uses a client model to query against the API. Create a client with your API credentials and make requests through that.
+
+```ruby
+require 'singleplatform'
+
+client = Singleplatform.new(
+  client_id:     ENV['CLIENT_ID']
+  client_secret: ENV['CLIENT_SECRET']
+)
+```
+
+After creating a client you're able to make requests to SinglePlatform's API. The Client ID and Client Secret are required for each request.
+
+### Locations
+
+With an initialized client, you can request information on locations in SinglePlatform's database.
+
+#### Fetching Locations by ID
+
+```ruby
+client.location('nobu')
+```
+
+This will return a Hashie::Mash pseudo object, which allows you to access attributes on the response using dot notation. Nested attributes continue to return Hashie::Mash objects until there are no children.
+
+```ruby
+location = client.location('nobu') # => #<Hashie::Mash ... >
+location.name                      # => "Nobu"
+location.attributes                # => #<Hashie::Mash ... >
+location.attributes.drive_thru     # => false
+```
+
+See SinglePlatform's API documentation for a full list of attributes.
+
+#### Fetching Locations Updated Since a Given Date
+
+You can retrieve locations en masse by calling:
+
+```ruby
+client.locations_updated_since('2016-08-01', limit: 100)
+```
+
+Results are paginated. The maximum (and default) limit per page is 5000.
+
+### Menus
+SinglePlatform locations have menus or lists of products and services that you can access with a configured API client. The following call returns an Array of Hashie::Mash objects.
+
+```ruby
+menus = client.menus_for('nobu') # => #<Array ... >
+menus.first.name                 # => "Dinner Menu"
+```
+
+See SinglePlatform's API documentation for the Menu schema with a full list of attributes.
+
+### Photos
+Many SinglePlatform locations have photos, both at the business and menu-item level. Returns an Array of Hashie::Mash objects.
+
+```ruby
+photos = client.photos_for('no') # => #<Array ... >
+photos.first.type                # => "Product"
+photos.first.url                 # => "http://xyz.cloudfront.net/.../39bf7671bc7d006f4cef72d94eee24aeec7615d2.jpg"
+```
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << ['test']
+  t.pattern = 'test/**/test_*.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/singleplatform.rb

@@ -0,0 +1,15 @@
+require 'singleplatform/client'
+
+module Singleplatform
+
+  class << self
+
+    # Alias for Singleplatform::Client.new
+    #
+    # @return [Singleplatform::Client]
+    def new(args = {})
+      Singleplatform::Client.new(args)
+    end
+
+  end
+end

data/lib/singleplatform/client.rb

@@ -0,0 +1,51 @@
+require 'singleplatform/client/request'
+require 'singleplatform/client/locations'
+require 'singleplatform/client/menus'
+require 'singleplatform/client/photos'
+require 'cgi'
+require 'uri'
+
+module Singleplatform
+  class Client
+    attr_accessor :base_url, :client_id, :client_secret
+
+    BASE_URL      = 'http://publishing-api.singleplatform.com'
+    CLIENT_ID     = ENV['CLIENT_ID'].freeze
+    CLIENT_SECRET = ENV['CLIENT_SECRET'].freeze
+
+    include Singleplatform::Client::Locations
+    include Singleplatform::Client::Menus
+    include Singleplatform::Client::Photos
+
+    # Initializes a new API Client Object
+    #
+    # @return [Singleplatform::Client]
+    def initialize(args = {})
+      @base_url      = BASE_URL
+      @client_id     = args[:client_id]
+      @client_secret = args[:client_secret]
+    end
+
+    # Form the complete URL for a given endpoint
+    # 
+    # @note Signature must be the last parameter
+    #
+    # @param path [String]
+    # @param params [Hash]
+    # @return [String]
+    def generate_url(path, params = {})
+      params['client'] = client_id
+      signature_base_string = "#{path}?#{URI.encode_www_form(params)}"
+      "#{base_url}#{signature_base_string}&signature=#{generate_signature(signature_base_string)}"
+    end
+
+    # Calculate the signature, Base64 and URL encode it
+    #
+    # @param base_string [String]
+    # @return [String]
+    def generate_signature(base_string)
+      key = OpenSSL::HMAC.digest('sha1', client_secret, base_string)
+      CGI::escape(Base64.encode64(key).chomp)
+    end
+  end
+end

data/lib/singleplatform/client/locations.rb

@@ -0,0 +1,30 @@
+module Singleplatform
+  class Client
+    module Locations
+      # Fetch information about a specific location
+      #
+      # @param id [String]
+      # @param options [Hash]
+      # @option options [String] :format Short menu ('short') available
+      # @return [Hashie::Mash]
+      def location(id, options = {})
+        url = generate_url("/locations/#{id}/", options)
+        Request.get(url)
+      end
+
+      # Fetch all locations updated since a given date
+      #
+      # @param date [String]
+      # @param options [Hash]
+      # @option options [Fixnum] :limit Maximum (default) 5000 per page
+      # @return [Hashie::Mash]
+      def locations_updated_since(date, options = {})
+        url = generate_url(
+          '/locations/updated_since/',
+          { date: date }.merge(options)
+        )
+        Request.get(url)
+      end
+    end
+  end
+end

data/lib/singleplatform/client/menus.rb

@@ -0,0 +1,16 @@
+module Singleplatform
+  class Client
+    module Menus
+      # Fetch all menus for a given location
+      #
+      # @param id [String]
+      # @param options [Hash]
+      # @option options [String] :format Short menu available ('short')
+      # @return [Hashie::Mash]
+      def menus_for(id, options = {})
+        url = generate_url("/locations/#{id}/menus", options)
+        Request.get(url)
+      end    
+    end
+  end
+end

data/lib/singleplatform/client/photos.rb

@@ -0,0 +1,27 @@
+module Singleplatform
+  class Client
+    module Photos
+      # Fetch photos for a given location
+      #
+      # @param date [String]
+      # @param options [Hash]
+      # @option options [Fixnum] :height
+      # @option options [Fixnum] :width
+      # @option options [String] :type (interior, exterior, item, logo, uncategorized)
+      # @return [Hashie::Mash]
+      def photos_for(id, options = {})
+        url = generate_url("/location/#{id}/photos", options)
+        Request.get(url)
+      end
+
+      # Fetch photos added/updated since a given date
+      #
+      # @param date [String]
+      # @return [Hashie::Mash]
+      def photos_updated_since(date)
+        url = generate_url('/photos/updated_since/', date: date)
+        Request.get(url)
+      end
+    end
+  end
+end

data/lib/singleplatform/client/request.rb

@@ -0,0 +1,24 @@
+require 'httparty'
+require 'hashie'
+
+module Singleplatform
+  class Request
+    # Make an HTTP get request to given URL
+    #
+    # @param url [String]
+    # @return [Hashie::Mash]
+    def self.get(url)
+      tries ||= 3
+      response = HTTParty.get(url)
+    rescue
+      sleep 3
+      if tries -= 1 > 0
+        retry
+      else
+        nil
+      end
+    else
+      Hashie::Mash.new(JSON.parse(response.body)).data
+    end
+  end
+end

data/lib/singleplatform/version.rb

@@ -0,0 +1,3 @@
+module Singleplatform
+  VERSION = '0.1.1'
+end

data/singleplatform.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'singleplatform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "singleplatform"
+  spec.version       = Singleplatform::VERSION
+  spec.authors       = ["Jeff Gharakhanian"]
+  spec.email         = ["jg@okayjeff.com"]
+
+  spec.summary       = "A Ruby client library for accessing the SinglePlatform API."
+  spec.homepage      = "http://github.com/okayjeff/singleplatform"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/singleplatform/test_client.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'singleplatform'
+
+class Singleplatform::ClientTest < Minitest::Test
+  def test_urls_generate_correctly
+    client = Singleplatform::Client.new(
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    )
+    path   = '/locations/updated_since/'
+    params = { date: '2016-08-01', limit: 100 }
+    url = client.generate_url(path, params)
+    assert_equal('http://publishing-api.singleplatform.com/locations/updated_since/?date=2016-08-01&limit=100&client=purplespacesuitfrogboots1&signature=D4mf0vL2jwJKU02OawPlXFXQymg%3D', url)
+  end
+end

data/test/test_singleplatform.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'singleplatform'
+
+class SingleplatformTest < Minitest::Test
+  def test_new_creates_new_client_object
+    client = Singleplatform.new(
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    )
+    assert_instance_of(Singleplatform::Client, client)
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: singleplatform
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jeff Gharakhanian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: 
+email:
+- jg@okayjeff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/singleplatform.rb
+- lib/singleplatform/client.rb
+- lib/singleplatform/client/locations.rb
+- lib/singleplatform/client/menus.rb
+- lib/singleplatform/client/photos.rb
+- lib/singleplatform/client/request.rb
+- lib/singleplatform/version.rb
+- singleplatform.gemspec
+- test/singleplatform/test_client.rb
+- test/test_singleplatform.rb
+homepage: http://github.com/okayjeff/singleplatform
+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.5
+signing_key: 
+specification_version: 4
+summary: A Ruby client library for accessing the SinglePlatform API.
+test_files: []