yipit_n4l 0.0.2

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+*.swo
+coverage
+doc
+.yardoc

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3

data/Gemfile

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

data/README.md

@@ -0,0 +1,58 @@
+# Yipit
+
+Simple Ruby wrapper for the Yipit [API](http://yipit.com/about/api_overview/). [Yipit](http://yipit.com) features deals aggregated from a number of sources, includng Groupon, LivingSocial, Restaurants.com, and more.
+
+## Under development
+
+    This fork of the Yipit Gem now works, but unless you are part of the secret sauce, you have **BEEN WARNED**.
+
+## Installation
+
+With `gem install`:
+
+    gem install yipit_n4l
+
+Or with bundler:
+
+		gem yipit_n4l, require: 'yipit'
+    
+## Usage
+
+You'll need a Yipit [API key](http://yipit.com/account/login/?next=/about/api_key/).
+
+### Instantiate
+    require 'Yipit'
+    client = Yipit::Client.new(YOUR_API_KEY)
+    
+Yipit uses a [`Hashie::Mash`](https://github.com/intridea/hashie) for return values, providing a handy hash that supports dot notation:
+
+    deal.title
+    => "$100 Gift Certificate, Your Price $40"
+    deal.division.name
+    => "New York"
+    
+### Issues
+  GitHub issue tracking sucks.  Submit issues to [`Lighthouse`](https://yipit.lighthouseapp.com)
+
+<a name="changelog"></a>
+## Changelog
+
+### 0.0.1 - March 14, 2011
+
+* Initial version
+
+## Under the hood
+* [`Faraday`](https://github.com/technoweenie/faraday) REST client
+* [`Hashie::Mash`](http://github.com/intridea/hashie)  Magic
+
+## How to contribute
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright (c) 2012 [Nest4Less, Inc.](http://nest4less.com). 

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/core_ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end

data/lib/yipit.rb

@@ -0,0 +1,91 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'core_ext/array'
+require 'hashie'
+
+module Yipit
+  class Client
+    attr_reader :api_key, :conn
+
+    # Initialize the client.
+    # TODO:  Document.
+    def initialize(*args)
+      options = args.extract_options!
+      @api_key = args[0]
+      @conn = Faraday.new(:url => "http://api.yipit.com") do |builder|
+        builder.adapter Faraday.default_adapter
+        builder.adapter  :logger if options[:debug] == true
+        builder.use Faraday::Response::ParseJson
+        builder.use Faraday::Response::Mashify
+      end
+    end
+
+    # @overload deals(options={})
+    #   Search for Deals
+    #   @param [Hash] options A customizable set of options
+    #   @option options [String] :lat Latitude of point to to sort deals by proximity to. Use with lon.  Uses radius.
+    #   @option options [String] :lon Longitude of point to to sort deals by proximity to. Use with lat.  Uses radius.
+    #   @option options [Fixnum] :radius Maximum distance of radius in miles to deal location from center point. Defaults to 10. Requires lat and lon
+    #   @option options [String] :divisions One or more division slugs (comma separated). See Divisions API for more details.
+    #   @option options [String] :source One or more source slugs (comma separated). See Sources API for more details.
+    #   @option options [String] :phone Deals available at a business matching one of the phone numbers. See Businesses API for more details.
+    #   @option options [String] :tag One or more tag slugs (comma separated). See Tags API for more details. Note: Specifying multiple tags returns deals matching any one of the tags, NOT all of them
+    #   @option options [Boolean] :paid Shows deals filtered on paid status.  Defaults to false. Set to true if you would like to see all deals.
+    #   @return [Array] An array of Hashie::Mash objects representing Yipit deals
+    #   @example Search deals by latitude and longitude
+    #       client.deals(:lat => "-37.74", :lon => "-76.00")
+    #   @example Search deals within a 2 miles radius of latitude and longitude
+    #       client.deals(:lat => "-37.74", :lon => "-76.00", :radius => 2)
+    #   @example Search deals from Groupon
+    #       client.deals(:source => "Groupon")
+    #   @example Search deals based on phone number
+    #       client.deals(:phone => "7185551212")
+    #   @example Search deals based on tags
+    #       client.deals(:tag => "restaurants,spa")
+    #   @example Search deals based on paid status. (Defaults to false)
+    #       client.deals(:paid => true)
+    # @overload deals(deal_id)
+    #   Get deal details
+    #   @param [Fixnum] deal_id A Deal Id
+    #   @return [Hashie::Mash] A Hashie::Mash object representing a Yipit deal
+    def deals(*args)
+      super
+    end
+
+    # @overload sources(options={})
+    #   Search for sources
+    #   @param [Hash] options A customizable set of options
+    #   @option options [String] :division One or more division slugs. See Divisions API for more details. Note: Specifying multiple divisions returns sources that exist in either of the divisions, NOT all of them.
+    #   @option options [String] :paid When paid is true, only paid sources are returned. Defaults to false.
+    # @overload sources(source_id)
+    #   Get source details
+    #   @param [String] slug A source slug
+    #   @return [Hashie::Mash] A Hashie::Mash object representing a Yipit Deal Source
+    def sources(*args)
+      super
+    end
+
+    # @overload tags(options={})
+    #   This method returns a list of all tags. There are no parameters specific to tags.
+    #   @param [Hash] options A customizable set of options
+    #   @return [Array] An array of Hashie::Mash objects representing Yipit tags.
+    def tags(*args)
+      super
+    end
+    def divisions(*args)
+      super
+    end
+    def businesses(*args)
+      super
+    end
+
+    def method_missing(sym, *args, &block)
+      options = args.extract_options!.merge(:key => api_key, :limit => 5000)
+      response = conn.get("/v1/#{sym.to_s}/#{args[0]}") { |req| req.params = options  }
+      puts response
+      ret = response.body['response']["#{sym.to_s}"]
+      mashes = ret.map{|h| Hashie::Mash.new(h)}
+      args[0].nil? ? mashes : mashes.first if mashes
+    end
+  end
+end

data/lib/yipit/version.rb

@@ -0,0 +1,3 @@
+module Yipit
+  VERSION = "0.0.2"
+end

data/spec/businesses/businesses_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../spec_helper', __FILE__)
+describe Yipit::Client do
+  context "api" do
+    before(:all) do
+      api_key="XZgnp3v2vyrBr3eR"
+      @client = Yipit::Client.new(api_key)
+    end
+   context "businesses" do
+      context "search businesses" do
+        # use_vcr_cassette
+        before(:all) do
+          @businesses = @client.businesses
+        end
+        specify { @businesses.size.should > 1 }
+      end
+      context "business details" do
+        before(:all) do
+          @businesses = @client.businesses("orpheum-theater")
+        end
+        specify { @business.name.should == "Orpheum Theatre" }
+      end
+    end
+  end
+end
+

data/spec/client/client_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../spec_helper', __FILE__)
+describe Yipit::Client do
+  context "api" do
+    before(:all) do
+      api_key="XZgnp3v2vyrBr3eR"
+      @client = Yipit::Client.new(api_key)
+    end
+   context "businesses" do
+      context "search businesses" do
+        # use_vcr_cassette
+        before(:all) do
+          @businesses = @client.businesses
+        end
+        specify { @businesses.size.should > 1 }
+      end
+      context "business details" do
+        before(:all) do
+          @businesses = @client.businesses(18005)
+        end
+        specify { @business.name.should == "Orpheum Theatre" }
+      end
+    end
+  end
+end

data/spec/deals/deals_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Yipit::Client do
+  context "api" do
+    before(:all) do
+      api_key="XZgnp3v2vyrBr3eR"
+      @client = Yipit::Client.new(api_key)
+    end
+    context "deals" do
+      context "search" do
+        context "with no args" do
+          use_vcr_cassette
+          before(:all) do
+            @deals = @client.deals
+          end
+          subject { @deals }
+          it { should_not be_nil }
+          it { should be_an(Array) }
+          it { should have(20).items }
+        end
+        context "with Brooklyn, NY lat/long" do
+          before(:all) do
+            @deals = @client.deals(:lat => "40.7325859", :lon => "-73.9568557")
+          end
+          subject { @deals }
+          it { should_not be_nil }
+          subject { @deals.first.division.name }
+          it { should eql "New York" }
+          subject { @deals.last.division.name }
+          it { should eql "New York" }
+        end
+        # TODO:  Better test.
+        context "with Brooklyn, NY lat/long, scoped to a 2 mile radius" do
+          before(:all) do
+            @deals = @client.deals(:lat => "40.7325859", :lon => "-73.9568557", :radius => 2)
+          end
+          subject { @deals }
+          it { should_not be_nil }
+          subject { @deals.first.division.name }
+          it { should eql "New York" }
+          subject { @deals.last.division.name }
+          it { should eql "New York" }
+        end
+        context "from Groupon" do
+          before(:all) do
+            @deals = @client.deals(:source => "Groupon")
+          end
+          subject { @deals }
+          it { should_not be_nil }
+          context "source name" do
+            subject { @deals.first.source.name }
+            it { should eql "Groupon" }
+            subject { @deals.last.source.name }
+            it { should eql "Groupon" }
+          end
+        end
+        context "by phone number" do
+          before(:all) do
+            @deals = @client.deals(:phone => "718-599-2700")
+          end
+          subject { @deals }
+          it { should_not be_nil }
+          subject { @deals.first.business.name.strip }
+          it { should eql "Kenny's Trattoria" }
+        end
+        context "tagged with 'restaurants'" do
+          before(:all) do
+            @deals = @client.deals(:tag => "restaurants")
+          end
+          subject { @deals }
+          it { should_not be_nil }
+          subject { @deals.first.tags.first.name }
+          it { should eql "Restaurants" }
+          subject { @deals.last.tags.first.name }
+          it { should eql "Restaurants" }
+        end
+        context "paid deals'" do
+          before(:all) do
+            @deals = @client.deals(:paid => "true")
+            require 'pp'
+            puts @deals.inspect
+          end
+          subject { @deals }
+          it { should_not be_nil }
+        end
+      end
+      context "details" do
+        before(:all) do
+          @deal = @client.deals(7238)
+        end
+        subject { @deal }
+        it { should_not be_nil }
+        it { should be_a(Hashie::Mash) }
+        it { should respond_to(:id) }
+        it { should respond_to(:title) }
+        it { should respond_to(:business) }
+        it { should respond_to(:images) }
+        it { should respond_to(:business) }
+        it { should respond_to(:division) }
+        it { should respond_to(:source) }
+        it { should respond_to(:tags) }
+        # etc...
+      end
+    end
+  end
+end

data/spec/divisions/divisions_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Yipit::Client do
+  context "api" do
+    before(:all) do
+      api_key="XZgnp3v2vyrBr3eR"
+      @client = Yipit::Client.new(api_key)
+    end
+    context "divisions" do
+      context "search divisions" do
+        # use_vcr_cassette
+        context "all" do
+          before(:all) do
+            @divisions = @client.divisions
+          end
+          context "the results" do
+            subject { @divisions }
+            specify { should_not be_nil }
+            specify { should have_at_least(1).items }
+          end
+        end
+        context "by source" do
+          before(:all) do
+            @divisions = @client.divisions(:source => "groupon")
+            puts @divisions.size
+          end
+          subject { @divisions }
+          context "the results" do
+            specify { should_not be_nil }
+            specify { should have_at_least(20).items }
+          end
+        end
+      end
+      context "division details" do
+        before(:all) do
+          @division = @client.divisions("new-york")
+        end
+        context "name" do
+          specify { @division.name.should == "New York" }
+        end
+      end
+    end
+  end
+end

data/spec/sources/sources_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Yipit::Client do
+  context "api" do
+    before(:all) do
+      api_key="XZgnp3v2vyrBr3eR"
+      @client = Yipit::Client.new(api_key)
+    end
+    context "sources" do
+      context "search sources" do
+        # use_vcr_cassette
+        context "all" do
+          before(:all) do
+            @sources = @client.sources
+          end
+          context "the results" do
+            subject { @sources }
+            specify { should_not be_nil }
+            specify { should have_at_least(1).items }
+          end
+        end
+        context "by division" do
+          before(:all) do
+            @sources = @client.sources(:divisions => "new-york")
+          end
+          subject { @sources }
+          context "the results" do
+            specify { should_not be_nil }
+            specify { should have_at_least(1).items }
+          end
+        end
+      end
+      context "source details" do
+        before(:all) do
+          @source = @client.sources("groupon")
+        end
+        context "name" do
+          specify { @source.name.should == "Groupon" }
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_group 'Yipit', 'lib/yipit'
+  add_group 'Specs', 'spec'
+end
+
+require File.expand_path('../../lib/yipit', __FILE__)
+require 'rubygems'
+require 'rspec'
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.stub_with                :typhoeus
+  c.default_cassette_options = { :record => :new_episodes }
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end

data/spec/tags/tags_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Yipit::Client do
+  context "api" do
+    before(:all) do
+      api_key=""
+      @client = Yipit::Client.new(api_key)
+    end
+    context "tags" do
+      context "search tags" do
+        # use_vcr_cassette
+        context "all" do
+          before(:all) do
+            @tags = @client.tags
+          end
+          context "the results" do
+            subject { @tags }
+            specify { should_not be_nil }
+            specify { should have_at_least(1).items }
+          end
+        end
+      end
+      context "when passing params to tags" do
+        before(:all) do
+          @tag = @client.tags("restaurants")
+        end
+        context "the tag" do
+          subject { @tag }
+          specify { should be_nil }
+        end
+      end
+    end
+  end
+end
+
+

data/yipit.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yipit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yipit_n4l"
+  s.version     = Yipit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Deeden", "Mark Coates"]
+  s.email       = ["mark@nest4less.com"]
+  s.homepage    = "http://github.com/Nest4LessDev/yipit"
+  s.summary     = %q{A simple wrapper for the Yipit API}
+  s.description = %q{A simple wrapper for the Yipit API}
+
+  s.rubyforge_project = "yipit_n4l"
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('vcr')
+  s.add_development_dependency('fakeweb')
+  s.add_development_dependency('yard')
+  s.add_development_dependency('maruku')
+  s.add_runtime_dependency("faraday")
+  s.add_runtime_dependency("faraday_middleware")
+  s.add_runtime_dependency("typhoeus")
+  s.add_runtime_dependency('hashie')
+  s.add_runtime_dependency('multi_json')
+
+  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"]
+end

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: yipit_n4l
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Josh Deeden
+- Mark Coates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple wrapper for the Yipit API
+email:
+- mark@nest4less.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/core_ext/array.rb
+- lib/yipit.rb
+- lib/yipit/version.rb
+- spec/businesses/businesses_spec.rb
+- spec/client/client_spec.rb
+- spec/deals/deals_spec.rb
+- spec/divisions/divisions_spec.rb
+- spec/sources/sources_spec.rb
+- spec/spec_helper.rb
+- spec/tags/tags_spec.rb
+- yipit.gemspec
+homepage: http://github.com/Nest4LessDev/yipit
+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'
+      segments:
+      - 0
+      hash: -4548077650586067815
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4548077650586067815
+requirements: []
+rubyforge_project: yipit_n4l
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for the Yipit API
+test_files:
+- spec/businesses/businesses_spec.rb
+- spec/client/client_spec.rb
+- spec/deals/deals_spec.rb
+- spec/divisions/divisions_spec.rb
+- spec/sources/sources_spec.rb
+- spec/spec_helper.rb
+- spec/tags/tags_spec.rb
+has_rdoc: