teachstreet 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+rdoc/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott Windsor & TeachStreet, Inc
+
+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.rdoc

@@ -0,0 +1,37 @@
+= teachstreet-ruby
+
+This is a Ruby client for the TeachStreet API
+
+For the specific documentation on APIs (and the full list of parameters) see:
+
+http://www.teachstreet.com/api/docs
+
+== Usage
+
+To create a new client, use your API key
+
+ >> client = Teachstreet.new('YOUR API KEY')
+
+Then, make calls 
+ >> listings = client.search_listings(:what => 'yoga', :where => 'Seattle, WA', :rpp => 1, :type => 'full')
+ => [#<Teachstreet::Listing:0x7f5be3e15028 @attrs={"average_rating"=>4, "subcategory"=>"Yoga", "price_aggregates"=>{"session_count"=>"1", "max_price"=>"78", "has_free"=>"0", "min_price"=>"78"}, "uri"=>"http://www.teachstreet.com:80/yoga/stay-young-with-yoga/li-3e1vivdvr4", "category"=>"Health & Fitness", "title"=>"Stay Young With YOGA", "listing_sessions"=>[{"location"=>{"lon"=>-122.28756, "address"=>"2811 Mt Rainier Dr S, Seattle, WA, 98144", "lat"=>47.577783}, "title"=>"Yoga for Re-charging", "price_amount"=>78.0, "id"=>"cl-kje72a8uao", "teacher_id"=>"us-1lanqsg9zk", "when"=>["March 09, 2011 - June 27, 2011", " 6:15 PM -  7:30 PM"], "date_created"=>Tue Jul 20 15:22:52 -0700 2010}], "id"=>"li-3e1vivdvr4", "owner_id"=>"us-1lanqsg9zk", "rating_count"=>28, "category_id"=>502, "img_url"=>"http://images2.teachst.com/image/view?e=cr-100-100&id=im-3d0uo54v3k&reference_id=ir-30x29hh1r4", "description"=>"Would you benefit from recharging? Yoga can help.  \r\n\r\nReaching your full potential requires mental and physical flexibility. Whether tight muscles come from intense athletic performance or from sitting at a desk all day, inflexibility limits your health, zaps your energy and constrains your freedom of movement. Yoga postures will inform you about which muscles are storing tension and about how to release them. And in this yoga class, you'll practice the body's natural mechanism for moving from anxiety to relaxation, deep breathing \342\200\223 and gain the bi-product of relaxing - mental flexibility. \r\nThis class is especially for \342\200\230baby-boomers, people without yoga training, & yoga veterans wanting a heart-centered experience, this class is accessible to everyone but deep in its impact. You\342\200\231ll be stretched and strengthened, your ability to focus will be enhanced and you\342\200\231ll come away feeling rejuvenated and ready to continue your day with new gusto. And you\342\200\231ll benefit from the side-effect of this practice, an upping of serotonin levels which boosts happiness!     \r\nCertified Kripalu teacher. \r\n\r\n", "subcategory_id"=>514, "date_created"=>Tue Mar 03 13:40:26 -0800 2009}]
+ >> listings.first.title
+ => "Stay Young With YOGA"
+ >> listings.first.listing_sessions.first
+ => #<Teachstreet::ListingSession:0x7f5be3dba2e0 @attrs={"location"=>{"lon"=>-122.28756, "address"=>"2811 Mt Rainier Dr S, Seattle, WA, 98144", "lat"=>47.577783}, "title"=>"Yoga for Re-charging", "price_amount"=>78.0, "id"=>"cl-kje72a8uao", "teacher_id"=>"us-1lanqsg9zk", "when"=>["March 09, 2011 - June 27, 2011", " 6:15 PM -  7:30 PM"], "date_created"=>Tue Jul 20 15:22:52 -0700 2010}
+
+JSON results are deserialized into classes: Listing, ListingSession, Location, Deal, Category, Subcategory, & PriceAggregates
+
+== Note on Patches/Pull Requests
+ 
+* 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
+
+Copyright (c) 2011 Scott Windsor & TeachStreet, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+
+gem 'hanna'
+require 'hanna/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "teachstreet #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+
+end

data/lib/teachstreet/version.rb

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

data/lib/teachstreet.rb

@@ -0,0 +1,148 @@
+require 'httparty'
+require 'facets/string'
+require 'facets/memoizable'
+
+module Teachstreet
+
+  class Error < StandardError
+    attr_reader :message, :code
+
+    def initialize(body)
+      parsed = Crack::XML.parse(body)
+      if parsed['wsvError']
+        @message = parsed['wsvError']['message']
+        @code = parsed['wsvError']['code']
+      end
+    end
+
+    def to_s
+      "#{code}: #{message}"
+    end
+
+  end
+
+  class Result
+    include Memoizable
+
+    def self.has_one(attr_name)
+      attr_sym = attr_name.to_sym
+      attr_string = attr_name.to_s
+      define_method attr_sym do
+        if @attrs.key?(attr_string)
+          Teachstreet.const_get(attr_string.camelcase).new(@attrs[attr_string])
+        end
+      end 
+      memoize attr_sym
+    end
+
+    def self.has_many(attr_name)
+      attr_sym = attr_name.to_sym
+      attr_string = attr_name.to_s
+      define_method attr_sym do
+        if @attrs.key?(attr_string)
+          @attrs[attr_string].map do |a|
+            Teachstreet.const_get(attr_string.gsub(/s$/i, '').camelcase).new(a)
+          end
+        end
+      end
+      memoize attr_sym
+    end
+
+    def initialize(attrs = {})
+      @attrs = attrs
+      (class << self; self; end).class_eval do
+        attrs.keys.each do |key|
+          if (!method_defined?(key) || key.to_s == 'id')
+            define_method key.to_sym do
+              @attrs[key]
+            end
+          end # end if
+        end # end each
+      end # end class_eval
+    end
+  end
+
+  class Category < Result
+  end
+
+  class Subcategory < Result
+  end
+
+  class Listing < Result
+    has_many :listing_sessions
+    has_one :price_aggregates
+  end
+
+  class PriceAggregates < Result
+  end
+
+  class ListingSession < Result
+    has_one :location
+  end
+
+  class Location < Result
+  end
+
+  class Deal < Result
+  end
+
+  class Client
+    include HTTParty
+
+    base_uri 'api.teachstreet.com'
+    format :json
+
+    # create a new client with your API key
+    def initialize(api_key)
+      self.class.default_params :wsvKey => api_key
+    end
+
+    # search listings local & online classes
+    def search_listings(options={})
+      process(self.class.get("/search/listings", :query => options)).map do |l|
+        Listing.new(l)
+      end
+    end
+
+    # look up a listing by id
+    def listing(id, options={})
+      Listing.new(process(self.class.get("/listing", :query => {:id => id}.merge(options))))
+    end
+
+    # find all categories
+    def categories
+      process(self.class.get("/categories")).map do |c|
+        Category.new(c)
+      end
+    end
+
+    # find all subscategories, or substring search by name
+    def subcategories(options = {})
+      process(self.class.get("/subcategories", :query => options)).map do |c|
+        Subcategory.new(c)
+      end
+    end
+
+    # find all deals
+    def deals(options ={})
+      process(self.class.get("/deals", :query => options))['deals'].map do |c|
+        Deal.new(c)
+      end
+    end
+
+    # look up deal by id
+    def deal(id, options={})
+      Deal.new(process(self.class.get("/deal/#{id}", options))["deal"])
+    end
+
+    private
+
+    def process(result)
+      if result.response.code == "200"
+        result.parsed_response
+      else
+        raise Teachstreet::Error, result.body
+      end
+    end
+  end
+end

data/spec/api_key.rb

@@ -0,0 +1,3 @@
+module Teachstreet
+  API_KEY = 'YOUR API KEY' # replace for testing
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'lib/teachstreet'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/teachstreet_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'api_key'
+
+describe Teachstreet do
+  before(:all) do
+    @client = Teachstreet::Client.new(Teachstreet::API_KEY)
+  end
+
+  it "lists all categories" do
+    result = @client.categories
+    result.should_not be_empty
+    result.first.name.should_not be_nil
+    result.first.url.should_not be_nil
+    result.first.id.should_not be_nil
+  end
+
+  it "lists all subcategories" do
+    result = @client.subcategories
+    result.should_not be_empty
+    result.first.name.should_not be_nil
+    result.first.url.should_not be_nil
+    result.first.id.should_not be_nil
+  end
+
+  it "list all subscategories for location" do
+    result = @client.subcategories(:where => 'Seattle, WA')
+    result.should_not be_empty
+    result.first.name.should_not be_nil
+    result.first.url.should_not be_nil
+    result.first.url.should match("seattle")
+    result.first.id.should_not be_nil
+  end
+
+  it "search for subcategory" do
+    result = @client.subcategories(:name => 'Programming')
+    result.should_not be_empty
+    result.first.name.should eql("Programming")
+    result.first.id.should eql(303)
+    result.first.url.should match("/programming/online-classes/303")
+  end
+
+  it "basic search listings for yoga in Seattle" do
+    result = @client.search_listings(:what => 'yoga', :where => 'Seattle, WA')
+    result.should_not be_empty
+    listing = result.first
+    listing.id.should_not be_nil
+    listing.title.should_not be_nil
+    listing.subcategory.should_not be_nil
+    listing.subcategory_id.should_not be_nil
+    listing.category.should_not be_nil
+    listing.category_id.should_not be_nil
+    listing.owner_id.should_not be_nil
+    listing.description.should_not be_nil
+    price_aggregates = listing.price_aggregates
+    price_aggregates.should_not be_nil
+    price_aggregates.should be_kind_of Teachstreet::PriceAggregates
+    price_aggregates.session_count.should_not be_nil
+    price_aggregates.max_price.should_not be_nil
+    price_aggregates.min_price.should_not be_nil
+    price_aggregates.has_free.should_not be_nil
+  end
+
+  it "full search listings for yoga in Seattle" do
+    result = @client.search_listings(:type => 'full', :what => 'yoga', :where => 'Seattle, WA')
+    result.should_not be_empty
+    listing = result.first
+    listing.id.should_not be_nil
+    listing.title.should_not be_nil
+    listing.subcategory.should_not be_nil
+    listing.subcategory_id.should_not be_nil
+    listing.category.should_not be_nil
+    listing.category_id.should_not be_nil
+    listing.owner_id.should_not be_nil
+    listing.description.should_not be_nil
+    listing.listing_sessions.should_not be_empty
+    listing_session = listing.listing_sessions.first
+    listing_session.should be_kind_of Teachstreet::ListingSession
+    listing_session.id.should_not be_nil
+    listing_session.title.should_not be_nil
+    listing_session.teacher_id.should_not be_nil
+    listing_session.location.should_not be_nil
+    location = listing_session.location
+    location.should be_kind_of Teachstreet::Location
+    price_aggregates = listing.price_aggregates
+    price_aggregates.should_not be_nil
+    price_aggregates.should be_kind_of Teachstreet::PriceAggregates
+    price_aggregates.session_count.should_not be_nil
+    price_aggregates.max_price.should_not be_nil
+    price_aggregates.min_price.should_not be_nil
+    price_aggregates.has_free.should_not be_nil
+  end
+
+  it "find basic listing by id" do
+    result = @client.search_listings(:what => 'yoga', :where => 'Seattle, WA')
+    result.should_not be_empty
+    listing = result.first
+    listing.id.should_not be_nil
+    listing = @client.listing(listing.id)
+    listing.should_not be_nil
+    listing.id.should_not be_nil
+    listing.title.should_not be_nil
+  end
+
+  it "find full listing by id" do
+    result = @client.search_listings(:what => 'yoga', :where => 'Seattle, WA')
+    result.should_not be_empty
+    listing = result.first
+    listing.id.should_not be_nil
+    listing = @client.listing(listing.id, :type => 'full')
+    listing.should_not be_nil
+    listing.id.should_not be_nil
+    listing.title.should_not be_nil
+  end
+
+  it "find all deals" do
+    deals = @client.deals
+    deals.should_not be_empty
+    deal = deals.first
+    deal.id.should_not be_nil
+  end
+
+  it "find deal by id" do
+    deals = @client.deals
+    deals.should_not be_empty
+    deal = @client.deal(deals.first.id)
+    deal.should_not be_nil
+    deal.id.should_not be_nil
+  end
+
+end

data/teachstreet.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "teachstreet/version"
+
+Gem::Specification.new do |s|
+  s.name        = "teachstreet"
+  s.version     = Teachstreet::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Windsor"]
+  s.email       = ["swindsor@teachstreet.com"]
+  s.homepage    = "http://github.com/TeachStreet/teachstreet-ruby"
+  s.summary     = %q{Client library for accessing TeachStreet's APIs}
+  s.description = %q{Client library for accessing TeachSTreet's APIs. Uses httparty for parsing.}
+
+  s.add_dependency("httparty", [">= 0.7.4"])
+  s.add_dependency("facets", [">= 2.9.1"])
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rdoc"
+  s.add_development_dependency "hanna"
+
+  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,151 @@
+--- !ruby/object:Gem::Specification 
+name: teachstreet
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 7
+        - 4
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: facets
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 2
+        - 9
+        - 1
+        version: 2.9.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hanna
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Client library for accessing TeachSTreet's APIs. Uses httparty for parsing.
+email: 
+- swindsor@teachstreet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/teachstreet.rb
+- lib/teachstreet/version.rb
+- spec/api_key.rb
+- spec/spec_helper.rb
+- spec/teachstreet_spec.rb
+- teachstreet.gemspec
+has_rdoc: true
+homepage: http://github.com/TeachStreet/teachstreet-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Client library for accessing TeachStreet's APIs
+test_files: []
+