hyperpublic 0.1.0

data/Gemfile

@@ -0,0 +1,25 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem "jeweler", "~> 1.5.1"
+gem "hashie", "~>1.1.0"
+gem "httparty", "~>0.7.8"
+gem "rest-client", "~>1.5.1"
+gem "multi_json", "~>1.0.3"
+gem "json"
+gem "fakeweb", "~>1.3.0"
+gem "yajl-ruby"
+gem 'addressable'
+
+group :development do
+  gem 'ruby-debug'
+  gem "rspec-rails", ">= 2.2.1"
+  gem 'autotest-growl'
+  gem 'ZenTest'
+  #gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.6.2)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    addressable (2.2.6)
+    autotest-growl (0.2.11)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
+    columnize (0.3.4)
+    crack (0.1.8)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    hashie (1.1.0)
+    hike (1.2.1)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    i18n (0.6.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.0)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    rack (1.3.3)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rbx-require-relative (0.0.5)
+    rdoc (3.9.4)
+    rest-client (1.5.1)
+      mime-types (>= 1.16)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    thor (0.14.6)
+    tilt (1.3.3)
+    yajl-ruby (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  addressable
+  autotest-growl
+  fakeweb (~> 1.3.0)
+  hashie (~> 1.1.0)
+  httparty (~> 0.7.8)
+  jeweler (~> 1.5.1)
+  json
+  multi_json (~> 1.0.3)
+  rest-client (~> 1.5.1)
+  rspec-rails (>= 2.2.1)
+  ruby-debug
+  yajl-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 etang
+
+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,71 @@
+#The Hyperpublic Ruby Gem
+=========================
+
+A Ruby wrapper for the Hyperpublic REST API
+
+
+Installation
+-------------
+    gem install hyperpublic_ruby
+
+
+Sample Usage
+-------------
+    require 'hyperpublic'
+
+    auth = Hyperpublic::OAuth.new("your_key", "your_secret")
+
+
+###Working with Places
+    places_client = Hyperpublic::Places.new(auth)
+
+    # find a single place by ID
+    place = places_client.find("4dd53bffe2f2d70816000001")
+
+    # find places by a query
+    places = places_client.find(:q => "chicken")
+
+    # find places by a location
+    places = places_client.find(:location => "416 w 13th st, New York")
+
+    # find places by multiple criteria
+    places = places_client.find(:category => "food", "postal_code" => 10012)
+
+    # create a place
+    places_client.create({:display_name => "Hyperpublic HQ",
+                          :tags => ["place_tag1", "place_tag2"].join(","),
+                          :image_url => "http://s3.amazonaws.com/prestigedevelopment/beta/image_photos/4dd535cab47dfd026c000002/square.png?1296938636",
+                          :phone_number => "2124857375",
+                          :website => "www.hyperpublic.com.com",
+                          :category_id => "4e274d89bd0286830f000170",
+                          :address => "416 w 13th st, New York, NY 10012",
+                          :lat => 40.7405, 
+                          :lon => -74.007})
+
+
+###Working with Geodeals & Events
+    offers_client = Hyperpublic::Offers.new(auth)
+
+    # find a single offer by ID
+    offer = offers_client.show("4e5e66f9a7ecee0001027a7b")
+
+    # find offers by a query
+    offers = offers_client.find(:q => "bowling")
+
+    # find offers by a location
+    offers = offers_client.find(:lat => 40.7, :lon => 74.0)
+
+    # find offers by multiple criteria
+    offers = offers_client.find(:source => "buywithme", :price_min => 10, :limit => 5)
+
+
+###Working with Categories
+    categories_client = Hyperpublic::Categories.new(auth)
+
+    # get a list of categories
+    categories = categories_client.find
+
+
+Documentation
+-------------
+Visit our [developer site](http://developer.hyperpublic.com) for full documentation.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'lib/hyperpublic/version.rb'
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = Hyperpublic::VERSION
+  gem.files = FileList['lib/**/*.rb', '[A-Z]*', 'spec/**/*'].to_a
+  gem.name = "hyperpublic_ruby"
+  gem.homepage = "http://github.com/jumppost/hyperpublic_api_ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Client library for the hyperpublic api}
+  gem.description = %Q{Provides easy access to the hyperpublic api}
+  gem.email = "etang@hyperpublic.com"
+  gem.authors = ["etang"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hyperpublic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/hyperpublic/all.rb

@@ -0,0 +1,18 @@
+module Hyperpublic
+  class All < Base
+    extend Forwardable
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def find(params)
+      q = Addressable::URI.new
+      q.query_values = stringify(params)
+      perform_get("/all?#{q.query}")
+    end
+  end
+end

data/lib/hyperpublic/base.rb

@@ -0,0 +1,117 @@
+require 'cgi'
+
+module Hyperpublic
+  class Base
+    extend Forwardable
+
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def search_neighborhoods(search_string, limit)
+      perform_get("/locations/search_neighborhoods", {:search_string => search_string, :limit => limit})
+    end
+
+    def search_tags(search_string, limit)
+      perform_get("/tags/search", {:search_string => search_string, :limit => limit})
+    end
+
+    def photos(params)
+      query = {}
+      case
+        when params[:ids] then query[:ids] = params[:ids]
+        when params[:object_id] && params[:object_type] then 
+          begin
+            query[:object_id] = params[:object_id]
+            query[:object_type] = params[:object_type]
+          end
+      end
+
+      perform_get("/photos", query)
+    end
+
+protected
+
+    def self.mime_type(file)
+      case
+        when file =~ /\.jpg/ then 'image/jpg'
+        when file =~ /\.gif$/ then 'image/gif'
+        when file =~ /\.png$/ then 'image/png'
+        else 'application/octet-stream'
+      end
+    end
+
+    def mime_type(f) self.class.mime_type(f) end
+
+    CRLF = "\r\n"
+
+    def self.build_multipart_bodies(parts)
+      boundary = Time.now.to_i.to_s(16)
+      body = ""
+      parts.each do |key, value|
+        esc_key = CGI.escape(key.to_s)
+        body << "--#{boundary}#{CRLF}"
+        if value.respond_to?(:read)
+          body << "Content-Disposition: form-data; name=\"#{esc_key}\"; filename=\"#{File.basename(value.path)}\"#{CRLF}"
+          body << "Content-Type: #{mime_type(value.path)}#{CRLF*2}"
+          body << value.read
+        else
+          body << "Content-Disposition: form-data; name=\"#{esc_key}\"#{CRLF*2}#{value}"
+        end
+        body << CRLF
+      end
+      body << "--#{boundary}--#{CRLF*2}"
+      {
+        :body => body,
+        :headers => {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
+      }
+    end
+
+    def build_multipart_bodies(parts) self.class.build_multipart_bodies(parts) end
+
+
+private
+
+    def stringify(obj)
+      if obj.is_a? Hash
+        obj.each do |key, value|
+          obj.delete(key)
+          obj[key.to_s] = stringify(value)
+        end
+      elsif obj.is_a? Array
+        obj.collect {|e| stringify(e)}
+      else
+        obj.to_s if obj
+      end
+    end
+
+    def arr_str(tags)
+      arr_str = (tags.is_a? Array) ? tags.join(",") : tags
+      arr_str
+    end
+
+    def perform_get(path, options={})
+      Hyperpublic::Request.get(self, path, options)
+    end
+
+    def perform_post(path, options={})
+      Hyperpublic::Request.post(self, path, options)
+    end
+
+    def perform_post_multi(path, options={})
+      Hyperpublic::Request.post_multi(self, path, options)
+    end
+
+    def perform_put(path, options={})
+      Hyperpublic::Request.put(self, path, options)
+    end
+
+    def perform_delete(path, options={})
+      Hyperpublic::Request.delete(self, path, options)
+    end
+  end
+end

data/lib/hyperpublic/categories.rb

@@ -0,0 +1,19 @@
+module Hyperpublic
+  class Categories< Base
+    extend Forwardable
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def find(params={})
+      q = Addressable::URI.new
+      q.query_values = stringify(params)
+      perform_get("/categories#{("?" + q.query) unless q.query.empty?}")
+    end
+  end
+end
+

data/lib/hyperpublic/oauth.rb

@@ -0,0 +1,63 @@
+require 'addressable/uri'
+require 'oauth'
+require 'oauth/consumer'
+require 'json'
+
+module Hyperpublic
+  class OAuth
+    extend Forwardable
+
+    attr_reader :ctoken, :csecret
+
+    def initialize(ctoken, csecret, options={})
+      @ctoken, @csecret, @consumer_options = ctoken, csecret, {}
+      @api_endpoint = options[:api_endpoint] || 'https://api.hyperpublic.com/api/v1'
+      @consumer = ::OAuth::Consumer.new(ctoken, csecret, :site => @api_endpiont)
+      @token = ::OAuth::AccessToken.new(@consumer)
+      @signing_endpoint = options[:signing_endpoint] || 'https://api.hyperpublic.com/api/v1'
+      if options[:sign_in]
+        @consumer_options[:authorize_path] =  '/oauth/authenticate'
+      end
+      @auth_params = "client_id=#{@ctoken}&client_secret=#{@csecret}" + (@token.token.empty? ? "" : "&access_token=#{@token.token}")
+      @auth_params_hash = {"client_id" => @ctoken, "client_secret" => @csecret}
+      @auth_params_hash["access_token"] = @token.token unless @token.token.empty?
+    end
+
+    def get(uri, options={})
+      path = @api_endpoint + uri
+      sep = (path =~ /\/.*\?/) ? "&" : "?"
+      @token.get(path + sep + @auth_params)
+    end
+
+    def post(uri, body, options={})
+      body.merge!("client_id" => @ctoken, "client_secret" => @csecret)
+      @token.post(@api_endpoint + uri, body.to_json, {"Content-Type" => 'application/json'})
+    end
+
+    def put(uri, body, options={})
+      @token.put(@api_endpoint + uri, body.merge(@auth_params_hash).to_json, {'Content-Type' => 'application/json'})
+    end
+
+    def delete(uri, options={})
+      path = @api_endpoint + uri
+      sep = (path =~ /\/.*\?/) ? "&" : "?"
+      @token.delete(path + sep + @auth_params)
+    end
+
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(signing_consumer, @atoken, @asecret)
+    end
+
+    def authorize_from_access(atoken, asecret)
+      @atoken, @asecret = atoken, asecret
+    end
+
+    private
+
+    def clear_request_token
+      @request_token = nil
+    end
+
+  end
+end
+

data/lib/hyperpublic/offers.rb

@@ -0,0 +1,27 @@
+module Hyperpublic
+  class Offers < Base
+    extend Forwardable
+
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def find(params={})
+      if params.is_a? String
+        perform_get("/offers/#{params}")
+      else
+        q = Addressable::URI.new
+        q.query_values = stringify(params)
+        perform_get("/offers?#{q.query}")
+      end
+    end
+
+    def show(id)
+      perform_get("/offers/#{id}")
+    end
+  end
+end

data/lib/hyperpublic/people.rb

@@ -0,0 +1,32 @@
+module Hyperpublic
+  class People < Base
+    extend Forwardable
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    #param can be 
+    #   id
+    #   {:ids => [1, 2, 3]}, 
+    #   {:tags => [tag1, tags]}, or 
+    #   {:location => {:lat=>35,:lon=>-70}}
+    #   etc
+    def find(params)
+      if params.is_a? String
+        perform_get("/people/#{params}")
+      else
+        q = Addressable::URI.new
+        q.query_values = stringify(params)
+        perform_get("/people?#{q.query}")
+      end
+    end
+
+    def create(options={})
+      perform_post("/people", :body => options)
+    end
+  end
+end

data/lib/hyperpublic/places.rb

@@ -0,0 +1,27 @@
+module Hyperpublic
+  class Places < Base
+    extend Forwardable
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def find(params)
+      if params.is_a? String
+        perform_get("/places/#{params}")
+      else
+        q = Addressable::URI.new
+        q.query_values = stringify(params)
+        perform_get("/places?#{q.query}")
+      end
+    end
+
+    def create(options={})
+      perform_post("/places", :body => options)
+    end
+
+  end
+end

data/lib/hyperpublic/request.rb

@@ -0,0 +1,105 @@
+module Hyperpublic
+  class Request
+    extend Forwardable
+
+    def self.get(client, path, options={})
+      new(client, :get, path, options).perform
+    end
+
+    def self.post(client, path, options={})
+      new(client, :post, path, options).perform
+    end
+
+    def self.post_multi(client, path, options={})
+      new(client, :post_multi, path, options).perform
+    end
+
+    def self.put(client, path, options={})
+      new(client, :put, path, options).perform
+    end
+
+    def self.delete(client, path, options={})
+      new(client, :delete, path, options).perform
+    end
+
+    attr_reader :client, :method, :path, :options
+
+    def_delegators :client, :get, :post, :post_multi, :put, :delete
+
+    def initialize(client, method, path, options={})
+      @client, @method, @path, @options = client, method, path, options
+    end
+
+    def uri
+      @uri ||= begin
+        uri = URI.parse(path)
+
+        if options[:query] && options[:query] != {}
+          uri.query = to_query(options[:query])
+        end
+
+        uri.to_s
+      end
+    end
+
+    def perform
+      Hyperpublic.make_friendly(send("perform_#{method}"))
+    end
+
+    private
+    def perform_get
+      get(uri, options[:headers])
+    end
+
+    def perform_post
+      post(uri, options[:body], options[:headers])
+    end
+
+    def perform_put
+      put(uri, options[:body], options[:headers])
+    end
+
+    def perform_delete
+      delete(uri, options[:headers])
+    end
+
+    def to_query(options)
+      options.inject([]) do |collection, opt|
+        collection << "#{opt[0]}=#{opt[1]}"
+        collection
+      end * '&'
+    end
+
+=begin
+    def perform_get
+      #get(uri, options || {})
+      get(uri)
+    end
+
+    def perform_post
+      #post(uri, options[:body], options[:headers] || {})
+      post(uri, options[:body])
+    end
+
+    def perform_post_multi
+      post_multi(uri, options[:body], options[:headers] || {})
+    end
+
+    def perform_put
+      put(uri, options[:body], options[:headers] || {})
+    end
+
+    def perform_delete
+      delete(uri, options[:headers] || {})
+    end
+
+    def to_query(options)
+      options.inject([]) do |collection, opt|
+        collection << "#{opt[0]}=#{opt[1]}"
+        collection
+      end * '&'
+    end
+=end
+  end
+end
+