hungrytable 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.sw*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@hungrytable --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Chapmap
+
+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,38 @@
+# Hungrytable
+
+The purpose of this gem is to interact with the [OpenTable](http://www.opentable.com) REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hungrytable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hungrytable
+
+## Usage
+
+You need to set some environment variable for this gem to work properly:
+
+Observe:
+
+    # In ~/.bashrc
+    export OT_PARTNER_ID=<YOUR OPENTABLE PARTNER ID>
+    export OT_PARTNER_AUTH=<YOUR OPENTABLE PARTNER AUTH> # For XML feed only...
+    export OT_OAUTH_KEY=<YOUR OPENTABLE OAUTH KEY>
+    export OT_OAUTH_SECRET=<YOUR OPENTABLE OAUTH SECRET KEY>
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/RELEASE_NOTES.md

@@ -0,0 +1,11 @@
+# Hungrytable - Ruby API Client for the OpenTable REST API
+
+## v0.0.1 (05/11/2012)
+
+* Get relevant details about an individual restaurant.
+* Search for availability at an individual restaurant.
+
+### Known Issues
+
+OpenTable's API currently returns search results as an unsupported transaction,
+but it is clearly marked as a thing in their API document.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end

data/hungrytable.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hungrytable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hungrytable"
+  s.version     = Hungrytable::VERSION
+  s.authors     = ["David Chapman"]
+  s.email       = ["david@isotope11.com"]
+  s.homepage    = "http://www.isotope11.com/"
+  s.summary     = %q{Gem to interact with OpenTable's REST API}
+  s.description = %q{Gem to interact with OpenTable's REST API}
+
+  s.rubyforge_project = "hungrytable"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  s.add_runtime_dependency 'oauth', '~> 0.4.5'
+  s.add_runtime_dependency 'json', '~> 1.7.1'
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "minitest-reporters"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'rcov', '0.9.11'
+  s.add_development_dependency 'pry'
+end
+

data/lib/hungrytable.rb

@@ -0,0 +1,9 @@
+require "uri"
+require "json"
+require "hungrytable/base"
+require "hungrytable/version"
+require "hungrytable/oauth_patch"
+require "hungrytable/restaurant"
+
+module Hungrytable
+end

data/lib/hungrytable/base.rb

@@ -0,0 +1,26 @@
+module Hungrytable
+  class Base
+    def validate_environment_variables
+      raise "Please set the environment variable OT_OAUTH_KEY to your OpenTable OAuth Table." unless ENV['OT_OAUTH_KEY']
+      raise "Please set the environment variable OT_OAUTH_SECRET to your OpenTable OAuth Secret Key." unless ENV['OT_OAUTH_SECRET']
+      raise "Please set the environment variable OT_PARTNER_ID to your OpentTable Partner ID." unless ENV['OT_PARTNER_ID']
+    end
+
+    def parse_uri_option(option_name, options)
+      val = options[option_name.to_sym]
+      raise "Missing required option: #{option_name}" if val.nil?
+      if val.is_a?(String)
+        val = CGI.escape(val).gsub(/[+]/, '%20')
+      end
+      instance_variable_set("@#{option_name}", val)
+    end
+
+    def parse_uri_options(*option_names, options)
+      option_names.each { |option_name| parse_uri_option(option_name, options) }
+    end
+
+    def parse_json(string)
+      JSON.parse(string)
+    end
+  end
+end

data/lib/hungrytable/oauth_patch.rb

@@ -0,0 +1,19 @@
+require 'oauth'
+module OAuth::Client
+  class Helper
+    def oauth_parameters
+      {   
+        'oauth_body_hash'        => options[:body_hash],
+        'oauth_callback'         => options[:oauth_callback],
+        'oauth_consumer_key'     => options[:consumer].key,
+        'oauth_token'            => options[:token] ? options[:token].token : '', 
+        'oauth_signature_method' => options[:signature_method],
+        'oauth_timestamp'        => timestamp,
+        'oauth_nonce'            => nonce,
+        'oauth_verifier'         => options[:oauth_verifier],
+        'oauth_version'          => (options[:oauth_version] || '1.0'),
+        'oauth_session_handle'   => options[:oauth_session_handle]
+      }.reject { |k,v| v.to_s == "" && k.to_s != 'oauth_token' }
+    end 
+  end 
+end

data/lib/hungrytable/restaurant.rb

@@ -0,0 +1,35 @@
+module Hungrytable
+  class Restaurant < ::Hungrytable::Base
+    def initialize
+      validate_environment_variables
+
+      @consumer = OAuth::Consumer.new(
+        ENV['OT_OAUTH_KEY'],
+        ENV['OT_OAUTH_SECRET'],
+        realm: 'http://www.opentable.com/',
+        site: 'https://secure.opentable.com/api/otapi_v2.ashx',
+        request_token_path: '',
+        authorize_path: '',
+        access_token_path: '',
+        oauth_token: '',
+        oauth_version: '1.0',
+        http_method: :get
+      )
+      
+      @access_token = OAuth::AccessToken.new(@consumer)
+    end
+
+    def get_details(restaurant_id)
+      uri = "/restaurant/?pid=#{ENV['OT_PARTNER_ID']}&rid=#{restaurant_id}"
+      response = @access_token.get(uri)
+      parse_json(response.body)
+    end
+
+    def search(options)
+      parse_uri_options(:restaurant_id, :date_time, :party_size, options)
+      uri = "/table/?pid=#{ENV['OT_PARTNER_ID']}&st=0&rid=#{@restaurant_id}&dt=#{@date_time}&ps=#{@party_size}"
+      response = @access_token.get(uri)
+      parse_json(response.body)
+    end
+  end
+end

data/lib/hungrytable/version.rb

@@ -0,0 +1,3 @@
+module Hungrytable
+  VERSION = "0.0.1"
+end

data/test/hungrytable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+describe Hungrytable do
+  subject { Hungrytable }
+  it 'should be a class' do
+    subject.class.must_equal Module
+  end
+end

data/test/support/minitest_junit.rb

@@ -0,0 +1,81 @@
+require 'ansi'
+
+module MiniTest
+  module Reporters
+    # A reporter identical to the standard MiniTest reporter.
+    # 
+    # Based upon Ryan Davis of Seattle.rb's MiniTest (MIT License).
+    # 
+    # @see https://github.com/seattlerb/minitest MiniTest
+    class JUnitReporter
+      include MiniTest::Reporter
+
+      def before_suites(suites, type)
+      end
+
+      def before_test(suite, test)
+      end
+
+      def pass(suite, test, test_runner)
+      end
+
+      def skip(suite, test, test_runner)
+      end
+
+      def failure(suite, test, test_runner)
+      end
+
+      def error(suite, test, test_runner)
+      end
+
+      def after_suites(suites, type)
+        time = Time.now - runner.start_time
+        i = 0
+        runner.report.each do |suite, tests|
+          File.open("#{suite.to_s.gsub(" ", '_').downcase}.xml", 'w') do |out|
+            out.puts '<?xml version="1.0" encoding="UTF-8" ?>'
+            out.puts "<testsuite errors=\"#{runner.errors}\" failures=\"#{runner.failures}\" tests=\"#{runner.test_count}\" time=\"#{time}\" timestamp=\"#{runner.start_time.strftime('%FT%R')}\">"
+            tests.each do |test, test_runner|
+              out.print "<testcase classname=\"#{suite}\" name=\"#{test}\" time=\"0\">"
+              message = message_for(test_runner)
+              out.puts "\n#{message}" if message
+              out.puts '</testcase>'
+            end
+            out.puts '</testsuite>'
+          end
+        end
+      end
+
+      private
+      def location(exception)
+        last_before_assertion = ''
+
+        exception.backtrace.reverse_each do |s|
+          break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+          last_before_assertion = s
+        end
+
+        last_before_assertion.sub(/:in .*$/, '')
+      end
+
+      def message_for(test_runner)
+        suite = test_runner.suite
+        test = test_runner.test
+        e = test_runner.exception
+
+        case test_runner.result
+        when :pass then nil
+        when :skip then "<skipped message=\"\"/>"
+        when :failure then "<failure message=\"#{e.message}\" type=\"failure\">#{location(e)}:\n#{e.message}\n</failure>"
+        when :error then "<error message=\"#{e.message}\" type=\"error\">#{location(e)}:\n#{e.message}\n</error>"
+        end
+      end
+
+      def status
+        '%d tests, %d assertions, %d failures, %d errors, %d skips' %
+          [runner.test_count, runner.assertion_count, runner.failures, runner.errors, runner.skips]
+      end
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+# Set up simplecov
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+require 'ostruct'
+require 'pry'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Set up minitest
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+if ENV['JENKINS']
+  MiniTest::Unit.runner.reporters << MiniTest::Reporters::JUnitReporter.new
+end
+
+# Load the app
+require File.expand_path("../../lib/hungrytable.rb", __FILE__)

data/test/unit/hungrytable/restaurant_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+describe Hungrytable::Restaurant do
+  subject { Hungrytable::Restaurant }
+
+  it 'should be a class' do
+    subject.class.must_be_kind_of Class
+  end
+
+  %w{ get_details search }.each do |meth|
+    it "should respond to #{meth}" do
+      assert subject.new.respond_to?(meth.to_sym), true
+    end
+  end
+
+  describe 'when getting details' do
+    before do
+      @restaurant = subject.new
+    end
+
+    it 'should return relevant details about an individual restaurant' do
+      response = @restaurant.get_details(82591)
+      response.must_be_kind_of Hash
+    end
+
+    it 'should look for availability at an inidividual restaurant' do
+      date_time = Time.now.strftime "%-m/#{Time.now.day + 1}/%Y %-l:%M %p"
+      response = @restaurant.search({ restaurant_id: 82591, date_time: date_time, party_size: 2 })
+      response.must_be_kind_of Hash
+    end
+
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: hungrytable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Chapman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &6926620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *6926620
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &6925700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *6925700
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &6924760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6924760
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: &6923840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6923840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &6922980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6922980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &6922200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6922200
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: &6921360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6921360
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &6854660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: *6854660
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &6852260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6852260
+description: Gem to interact with OpenTable's REST API
+email:
+- david@isotope11.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- RELEASE_NOTES.md
+- Rakefile
+- hungrytable.gemspec
+- lib/hungrytable.rb
+- lib/hungrytable/base.rb
+- lib/hungrytable/oauth_patch.rb
+- lib/hungrytable/restaurant.rb
+- lib/hungrytable/version.rb
+- test/hungrytable_test.rb
+- test/support/minitest_junit.rb
+- test/test_helper.rb
+- test/unit/hungrytable/restaurant_test.rb
+homepage: http://www.isotope11.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: hungrytable
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Gem to interact with OpenTable's REST API
+test_files:
+- test/hungrytable_test.rb
+- test/support/minitest_junit.rb
+- test/test_helper.rb
+- test/unit/hungrytable/restaurant_test.rb