livingsocial2 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,7 @@
 # Livingsocial2
 
-TODO: Write a gem description
+This is the official unoffical ruby gem for Livingsocial.  The gem is a wrapper for livingsocial's atom feed.  We scrape the atom feed every 3 hours, so the deals should be current.  There are some inconsistency with info on some deals, but this stems from inconsistencies within the atom feed - not much we can do there! The gem is very lightweight with only two files - Mongo.rb and Deal.rb.  Mongo creates a connection to the mongo db that stores the gathered deals and Deal returns deal instances based on your entered criteria.
+
 
 ## Installation
 
@@ -18,7 +19,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+There are currently 2 class level methods for interacting with the gem.
+### Method 1
+Livingsocial2::Deal.find_by_ls_market(deal_type, market) #=> returns a collection of deals objects that match both the deal_type and the LS market of interest.
+
+### Example call
+Livingsocial2::Deal.find_by_ls_market(:local, 'Buffalo')
+
+### Method 2
+Livingsocial2::Deal.find_near(deal_type, lat, long, distance) #=> returns a collection of deal objects that match the deal type and that are within the specified distance of the lat and long passed in.
+
+### Example call
+Livingsocial2::Deal.find_near(:all, 40.7518481, -73.97551399999999, 1)
+
+Distance is the radius desired, measured in miles.  For example, the above example is asking for all the deals within a 1 mile radius of the passed in location (Lexington, NY).
+
+If no distance is specified - it will default to 3 miles.
+### What's the deal with deal_type
+deal_type allows you to specify what LS vertical you are interested in.  Currently, the atom feed supplies 4 types of deals.
+#### 1. Local Deals
+#### 2. At Home Deals
+#### 3. Families Deals
+#### 4. Gourmet Deals
+
+### To specify a deal_type pass in one of the following symbols
+#### 1. :local #=> local deals
+#### 2. :at_home #=> at home deals
+#### 3. :family #=> family deals
+#### 4. :gourmet #=> gourmet deals
+#### 5. :all #=> combination of all the above
 
 ## Contributing
 

data/lib/livingsocial2/deal.rb

@@ -0,0 +1,66 @@
+module Livingsocial2
+  class Deal
+    DEAL_TYPES = {  family:  'FamiliesDeal',
+                    local:   'LocalDeal',
+                    at_home: 'AtHomeDeal',
+                    gourmet: 'GourmetDeal',
+                    all:     'all' }
+
+    attr_accessor :ls_id, :published, :link, :title, :long_title, :deal_type,
+                  :merchandise_type, :market_id, :market_name, :market_location,
+                  :featureType, :country_code, :subtitle, :offer_ends_at,
+                  :price, :value, :savings, :order_count, :merchant_type,
+                  :image_url, :categories, :sold_out, :national, :description,
+                  :details, :content, :merchant
+
+    def initialize(attributes)
+      self.ls_id            = attributes['ls_id']
+      self.published        = attributes['published']
+      self.link             = attributes['link']
+      self.title            = attributes['title']
+      self.long_title       = attributes['long_title']
+      self.deal_type        = attributes['deal_type']
+      self.merchandise_type = attributes['merchandise_type']
+      self.market_id        = attributes['market_id']
+      self.market_name      = attributes['market_name']
+      self.market_location  = attributes['market_location']
+      self.featureType      = attributes['featureType']
+      self.country_code     = attributes['country_code']
+      self.subtitle         = attributes['subtitle']
+      self.offer_ends_at    = attributes['offer_ends_at']
+      self.price            = attributes['price']
+      self.value            = attributes['value']
+      self.savings          = attributes['savings']
+      self.order_count      = attributes['order_count']
+      self.merchant_type    = attributes['merchant_type']
+      self.image_url        = attributes['image_url']
+      self.categories       = attributes['categories']
+      self.sold_out         = attributes['sold_out']
+      self.national         = attributes['national']
+      self.description      = attributes['description']
+      self.details          = attributes['details']
+      self.content          = attributes['content']
+      self.merchant         = attributes['merchant']
+    end
+
+    def self.find_deals_for(deal_type)
+      if deal_type == 'all'
+        LivingSocialDeal
+      else
+        LivingSocialDeal.where(deal_type: deal_type)
+      end
+    end
+
+    def self.find_by_ls_market(deal_type, market)
+      valid_deals = find_deals_for(DEAL_TYPES[deal_type]).where(title: market.capitalize)
+      valid_deals.map { |deal| new(deal.attributes) }
+    end
+
+    def self.find_near(deal_type, lat, long, distance=3)
+      valid_deals = find_deals_for(DEAL_TYPES[deal_type]).where(:market_location => { "$near" => [lat, long], "$maxDistance" => distance.fdiv(69) })
+      valid_deals.map { |deal| new(deal.attributes) }
+    end
+  end
+end
+
+

data/lib/livingsocial2/mongo.rb

@@ -0,0 +1,43 @@
+require 'mongoid'
+Mongoid::Config.from_hash({ "database" => 'app4574678',
+                            'host' => 'pearl.mongohq.com',
+                            'username' => 'ha',
+                            'password' => 'hungry',
+                            'port' => '27019' })
+
+class LivingSocialDeal
+  include Mongoid::Document
+
+  field :ls_id
+  field :published
+  field :link
+  field :title
+  field :long_title
+  field :deal_type
+  field :merchandise_type
+  field :market_id
+  field :market_name
+  field :market_location, type: Array
+  field :featureType
+  field :country_code
+  field :subtitle
+  field :offer_ends_at
+  field :price
+  field :value
+  field :savings
+  field :order_count
+  field :merchant_type
+  field :image_url
+  field :categories
+  field :sold_out
+  field :national
+  field :description
+  field :details
+  field :content
+  field :merchant
+
+  index(
+    [[:market_location, Mongo::GEO2D]], background: true
+  )
+
+end

data/lib/livingsocial2/version.rb

@@ -1,3 +1,3 @@
 module Livingsocial2
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/livingsocial2.rb

@@ -1,6 +1,5 @@
+require "livingsocial2/mongo"
 require "livingsocial2/version"
-require "livingsocial2/client"
-require "livingsocial2/daily_deal"
-require "livingsocial2/national_deal"
-require 'faraday'
-require 'json'
+require "livingsocial2/deal"
+require 'mongoid'
+

data/livingsocial2.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Livingsocial2::VERSION
 
-  gem.add_runtime_dependency("faraday")
   gem.add_development_dependency('rspec')
+  gem.add_development_dependency('mongoid')
+  gem.add_development_dependency('bson_ext')
 end

data/spec/deal_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Livingsocial2::Deal do
+  context 'When searching for a deal' do
+    describe '.find_deals_for(deal_type)' do
+      it 'returns an array of matching mongoid objects' do
+        deals = Livingsocial2::Deal.find_deals_for("AtHomeDeal")
+        deals.class.should be(Mongoid::Criteria)
+      end
+    end
+
+    describe '.find_by_ls_market(deal_type, market)' do
+      it 'returns an array of Livingsocial2::Deal objects' do
+        deals = Livingsocial2::Deal.find_by_ls_market(:all, 'Buffalo')
+        deals.first.class.should be(Livingsocial2::Deal)
+      end
+
+      it 'returns an empty array if invalide deal_type is entered' do
+        deals = Livingsocial2::Deal.find_by_ls_market(:happy_days, 'Buffalo')
+        deals.should be_empty
+      end
+
+      it 'returns an empty array if invalide market is entered' do
+        deals = Livingsocial2::Deal.find_by_ls_market(:all, 'Icelandia')
+        deals.should be_empty
+      end
+    end
+
+    describe '.find_near(deal_type, lat, long, distance)' do
+      it 'returns Livingsocial2::Deal instances that are within the given distance' do
+        deals = Livingsocial2::Deal.find_near(:all, 40.7518481, -73.97551399999999, 1)
+        deals.first.class.should be(Livingsocial2::Deal)
+      end
+
+      it 'returns an empty array if no deals match given criteria' do
+        deals = Livingsocial2::Deal.find_near(:all, 39.904214, 116.407413, 1)
+        deals.should be_empty
+      end
+
+      it 'returns an empty array if lat and long are passed in as strings' do
+        deals = Livingsocial2::Deal.find_near(:all, "40.7518481", "-73.97551399999999", 1)
+        deals.should be_empty
+      end
+
+      context "when no distance is given, it defaults to a radius of 3 miles" do
+        it 'returns an array of Livingsocial2::Deal objects' do
+          deals = Livingsocial2::Deal.find_near(:all, 40.7518481, -73.97551399999999)
+          deals.first.class.should be(Livingsocial2::Deal)
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require './lib/livingsocial2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livingsocial2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: &70196314032140 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70181352393960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *70196314032140
+  version_requirements: *70181352393960
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70196314031340 !ruby/object:Gem::Requirement
+  name: mongoid
+  requirement: &70181352393280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70181352393280
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70181352392840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196314031340
+  version_requirements: *70181352392840
 description: Wrapper for the livingsocial atom feed
 email:
 - michael.v.verdi@gmail.com
@@ -40,17 +51,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- lib/.DS_Store
 - lib/livingsocial2.rb
-- lib/livingsocial2/client.rb
-- lib/livingsocial2/daily_deal.rb
-- lib/livingsocial2/national_deal.rb
+- lib/livingsocial2/deal.rb
+- lib/livingsocial2/mongo.rb
 - lib/livingsocial2/version.rb
 - livingsocial2.gemspec
+- spec/deal_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -75,4 +89,6 @@ rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Wrapper for the livingsocial atom feed
-test_files: []
+test_files:
+- spec/deal_spec.rb
+- spec/spec_helper.rb

data/lib/livingsocial2/client.rb

@@ -1,27 +0,0 @@
-require 'faraday'
-require 'json'
-
-module Livingsocial2Api
-  class Client
-    BASE_URL = "http://50.116.44.82:3000"
-
-    attr_reader :connection
-
-    def initialize
-      @connection = Faraday.new(BASE_URL)
-    end
-
-    def data(location)
-      response = @connection.get do |req|
-        req.url "/api/v1/deals"
-        req.headers['Accepts'] = 'application/json'
-        req.params['division_name'] = clean_location(location)
-      end
-      JSON.parse(response.body)
-    end
-
-    def clean_location(location)
-      location.gsub("-", " ")
-    end
-  end
-end

data/lib/livingsocial2/daily_deal.rb

@@ -1,31 +0,0 @@
-module Livingsocial2Api
-  class DailyDeal
-    attr_accessor :image_url, :url, :description, :title, :deal_price, :original_price
-
-    def initialize(attributes)
-      self.image_url      = attributes[:image_url]
-      self.url            = attributes[:url]
-      self.description    = attributes[:description]
-      self.title          = attributes[:title]
-      self.deal_price     = attributes[:deal_price]
-      self.original_price = attributes[:original_price]
-    end
-
-    def self.client
-      Livingsocial2Api::Client.new
-    end
-
-    def self.deal_for(location)
-      client.data(location).map do |deal|
-        attributes = { image_url:      deal['image_url'],
-                       url:            deal['original_url'],
-                       description:    deal['subtitle'],
-                       title:          deal['title'],
-                       deal_price:     deal['price_cents'],
-                       original_price: deal['value_cents'],
-                      }
-        new(attributes)
-      end
-    end
-  end
-end

data/lib/livingsocial2/national_deal.rb

@@ -1,31 +0,0 @@
-module Livingsocial2Api
-  class NationalDeal
-    attr_accessor :image_url, :url, :description, :title, :deal_price, :original_price
-
-    def initialize(attributes)
-      self.image_url      = attributes[:image_url]
-      self.url            = attributes[:url]
-      self.description    = attributes[:description]
-      self.title          = attributes[:title]
-      self.deal_price     = attributes[:deal_price]
-      self.original_price = attributes[:original_price]
-    end
-
-    def self.client
-      Livingsocial2Api::Client.new
-    end
-
-    def self.deal(location='Nationwide')
-      client.data(location).map do |deal|
-        attributes = { image_url:      deal['image_url'],
-                       url:            deal['original_url'],
-                       description:    deal['subtitle'],
-                       title:          deal['title'],
-                       deal_price:     deal['price_cents'],
-                       original_price: deal['value_cents'],
-                      }
-        new(attributes)
-      end
-    end
-  end
-end