thrillcall-api 0.0.4 → 0.0.6

data/docs/WRAPPER.html

@@ -64,7 +64,7 @@
 .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
 </style><h1>Thrillcall API</h1>
 
-<p>This document describes the Thrillcall API v2, and usage for the provided Ruby API wrapper gem.</p>
+<p>This document describes the Thrillcall API v3, and usage for the provided Ruby API wrapper gem.</p>
 
 <h1>Ruby API Wrapper</h1>
 
@@ -123,7 +123,7 @@
 <div class="highlight">
 <pre>    <span class="c1">#---------------------------------------------------------------#</span>
     <span class="c1"># The default SSL endpoint is "https://api.thrillcall.com/api/".</span>
-    <span class="c1"># The default API version is 2.</span>
+    <span class="c1"># The default API version is 3.</span>
     <span class="c1"># By default, Faraday access logging is turned off.</span>
     <span class="c1"># Override if necessary:</span>
     <span class="c1">#---------------------------------------------------------------#</span>
@@ -161,7 +161,7 @@
     <span class="nb">require</span> <span class="s1">'json'</span>
 
     <span class="no">MY_API_KEY</span>  <span class="o">=</span> <span class="s2">"1234567890abcdef"</span>
-    <span class="no">BASE_URL</span>    <span class="o">=</span> <span class="s2">"https://api.thrillcall.com/api/v2/"</span>
+    <span class="no">BASE_URL</span>    <span class="o">=</span> <span class="s2">"https://api.thrillcall.com/api/v3/"</span>
     <span class="no">HEADERS</span>     <span class="o">=</span> <span class="p">{</span> <span class="ss">:accept</span> <span class="o">=&gt;</span> <span class="s1">'application/json'</span> <span class="p">}</span>
 
     <span class="n">connection</span>  <span class="o">=</span> <span class="no">Faraday</span><span class="o">.</span><span class="n">new</span><span class="p">(</span> <span class="ss">:url</span> <span class="o">=&gt;</span> <span class="no">BASE_URL</span><span class="p">,</span> <span class="ss">:headers</span> <span class="o">=&gt;</span> <span class="no">HEADERS</span> <span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">builder</span><span class="o">|</span>

data/docs/WRAPPER.md

@@ -1,5 +1,5 @@
 # Thrillcall API
-This document describes the Thrillcall API v2, and usage for the provided Ruby API wrapper gem.
+This document describes the Thrillcall API v3, and usage for the provided Ruby API wrapper gem.
 
 # Ruby API Wrapper
 ### Usage:
@@ -56,7 +56,7 @@ Provide additional instantiation options:
     
     #---------------------------------------------------------------#
     # The default SSL endpoint is "https://api.thrillcall.com/api/".
-    # The default API version is 2.
+    # The default API version is 3.
     # By default, Faraday access logging is turned off.
     # Override if necessary:
     #---------------------------------------------------------------#
@@ -94,7 +94,7 @@ This gem is a convenience wrapper around the excellent Faraday project.  If more
     require 'json'
     
     MY_API_KEY  = "1234567890abcdef"
-    BASE_URL    = "https://api.thrillcall.com/api/v2/"
+    BASE_URL    = "https://api.thrillcall.com/api/v3/"
     HEADERS     = { :accept => 'application/json' }
     
     connection  = Faraday.new( :url => BASE_URL, :headers => HEADERS ) do |builder|

data/lib/thrillcall-api.rb

@@ -12,8 +12,9 @@ module ThrillcallAPI
     def new(cur_api_key, options = {})
       default_options = {
         :base_url   => "https://api.thrillcall.com/api/",
-        :version    => 2,
-        :logger     => false
+        :version    => 3,
+        :logger     => false,
+        :timeout    => 20
       }
 
       opts = default_options.merge(options)
@@ -23,6 +24,11 @@ module ThrillcallAPI
       version       = opts[:version]
       logger        = opts[:logger]
 
+      faraday_opts  = {
+        :timeout      => opts[:timeout],
+        :open_timeout => opts[:timeout]
+      }
+
       # Make sure the base_url is in the form https://.../
       unless base_url.match /^(http|https):\/\//
         base_url = "https://" + base_url
@@ -39,7 +45,7 @@ module ThrillcallAPI
       }
 
       @base   = "#{base_url}v#{version}/"
-      @conn   = Faraday.new( :url => @base, :headers => @headers ) do |builder|
+      @conn   = Faraday.new( :url => @base, :headers => @headers, :options => faraday_opts ) do |builder|
         builder.adapter Faraday.default_adapter
         if logger
           builder.response :logger

data/lib/thrillcall-api/version.rb

@@ -1,3 +1,3 @@
 module ThrillcallAPI
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/spec/thrillcall-api/thrillcall-api_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'thrillcall-api'
 require 'ap'
 require 'faker'
+require 'tzinfo'
 
 # Set to one of :development, :staging, :production
 TEST_ENV                  = :development
@@ -36,6 +37,7 @@ TEST_KEY                  = ENV["TC_#{env_prefix}_API_KEY"]
 PERSON_EMAIL              = ENV["TC_#{env_prefix}_EMAIL"]
 PERSON_PASSWORD           = ENV["TC_#{env_prefix}_PASSWORD"]
 
+PERSON_KNOWN_ID           = ENV["TC_#{env_prefix}_KNOWN_ID"]
 PERSON_KNOWN_UID          = ENV["TC_#{env_prefix}_KNOWN_UID"]
 PERSON_KNOWN_TOKEN        = ENV["TC_#{env_prefix}_KNOWN_TOKEN"]
 PERSON_KNOWN_EMAIL        = ENV["TC_#{env_prefix}_KNOWN_EMAIL"]
@@ -47,6 +49,7 @@ HOST                      = "http://localhost:3000/api/"                    if T
 HOST                      = "https://secure-zion.thrillcall.com:443/api/"   if TEST_ENV == :staging        # SSL!
 HOST                      = "https://api.thrillcall.com:443/api/"           if TEST_ENV == :production     # SSL!
 
+MAX_LIMIT                 = 175
 LIMIT                     = 14
 TINY_LIMIT                = 3
 
@@ -100,6 +103,7 @@ describe "ThrillcallAPI" do
       day_buffer            = 0
       range                 = 365
 
+      @beginning_of_time    = (Time.now - 60*60*24*((range*5)+day_buffer)).to_date.to_s
       @min_date             = (Time.now - 60*60*24*(range+day_buffer)).to_date.to_s
       @max_date             = (Time.now - 60*60*24*day_buffer).to_date.to_s
 
@@ -136,6 +140,7 @@ describe "ThrillcallAPI" do
 
       @genre_id             = @artist["primary_genre_id"]
       @metro_area_id        = @venue["metro_area_id"]
+      @metro_area_time_zone = @tc.metro_area(@metro_area_id)["time_zone"]
 
       puts "Using Thrillcall objects:"
       puts "Event:    #{@event_id}"
@@ -179,6 +184,15 @@ describe "ThrillcallAPI" do
     tc_permissions.class.should == Array
   end
 
+  it "should return a 401 error if using an invalid API key" do
+    tc = ThrillcallAPI.new("bogus key", :base_url => HOST)
+
+    tc_permissions = tc.api_key.permissions
+    lambda {
+      tc_permissions.length
+    }.should raise_error
+  end
+
   context "an authenticated user with get permission" do
 
     before :all do
@@ -282,11 +296,17 @@ describe "ThrillcallAPI" do
         e["id"].should == @venue_id
       end
 
+      it "should verify the behavior of the limit maximum" do
+        e = @tc.events(:limit => MAX_LIMIT, :min_date => @beginning_of_time)
+
+        e.length.should == MAX_LIMIT
+      end
+
       it "should verify the behavior of the min_date param" do
         e = @tc.events(:limit => TINY_LIMIT, :min_date => @min_date)
         e.length.should == TINY_LIMIT
         e.each do |ev|
-          DateTime.parse(ev["start_date"]).should >= DateTime.parse(@min_date)
+          DateTime.parse(ev["starts_at"]).should >= DateTime.parse(@min_date)
         end
       end
 
@@ -294,7 +314,45 @@ describe "ThrillcallAPI" do
         e = @tc.events(:limit => TINY_LIMIT, :min_date => @min_date, :max_date => @max_date)
         e.length.should == TINY_LIMIT
         e.each do |ev|
-          DateTime.parse(ev["start_date"]).should < (DateTime.parse(@max_date) + 1)
+          DateTime.parse(ev["starts_at"]).should < (DateTime.parse(@max_date) + 1)
+        end
+      end
+
+      it "should verify the behavior of the min_updated_at param" do
+        e = @tc.events(:limit => TINY_LIMIT, :min_updated_at => @min_date)
+        e.length.should == TINY_LIMIT
+        e.each do |ev|
+          DateTime.parse(ev["updated_at"]).should >= DateTime.parse(@min_date)
+        end
+      end
+
+      it "should verify the behavior of the max_updated_at param" do
+        e = @tc.events(:limit => TINY_LIMIT, :min_updated_at => @min_date, :max_updated_at => @max_date)
+        e.length.should == TINY_LIMIT
+        e.each do |ev|
+          DateTime.parse(ev["updated_at"]).should < (DateTime.parse(@max_date) + 1)
+        end
+      end
+
+      it "should verify the behavior of the time_zone param" do
+        tz      = "Asia/Tokyo"
+        offset  = 9/24.0
+        e = @tc.events(:limit => TINY_LIMIT, :min_date => @min_date, :max_date => @max_date, :time_zone => tz)
+        e.length.should == TINY_LIMIT
+
+        after = DateTime.parse(@min_date).new_offset(offset) - offset        # should be 15:00 utc
+        before = (DateTime.parse(@max_date).new_offset(offset) + 1) - offset # should be 15:00 utc
+
+        puts "min_date: #{@min_date} (#{after})"
+        puts "max_date: #{@max_date} (#{before})"
+
+        e.each do |ev|
+          d = DateTime.parse(ev["starts_at_local"])
+
+          puts "Checking #{ev["starts_at_local"]} : #{d}"
+
+          d.should >= after
+          d.should < before
         end
       end
 
@@ -307,6 +365,13 @@ describe "ThrillcallAPI" do
         (e - o).length.should == TINY_LIMIT
       end
 
+      it "should verify the behavior of the show_disabled_events param" do
+        e = @tc.events(:limit => MAX_LIMIT, :show_disabled_events => false)
+        e.each do |ev|
+          ev["status"].should_not == :disabled
+        end
+      end
+
       it "should verify the behavior of the confirmed_events_only param" do
         e = @tc.events(:limit => LIMIT, :confirmed_events_only => true)
         e.each do |ev|
@@ -466,6 +531,30 @@ describe "ThrillcallAPI" do
 
         @tc.venue(cur_venue_id)["metro_area_id"].should == @metro_area_id
       end
+
+      it "should get events based on the time zone of the metro" do
+        tz = TZInfo::Timezone.get(@metro_area_time_zone)
+        offset = (tz.current_period.offset.utc_offset / (60 * 60)) / 24.0
+        puts "Time zone is: #{@metro_area_time_zone}, offset #{offset}"
+
+        e = @tc.metro_area(@metro_area_id).events(:min_date => @min_date, :max_date => @max_date, :limit => TINY_LIMIT)
+        e.first["venue_id"]
+
+        after = DateTime.parse(@min_date).new_offset(offset) - offset
+        before = (DateTime.parse(@max_date).new_offset(offset) + 1) - offset
+
+        puts "min_date: #{@min_date} (#{after})"
+        puts "max_date: #{@max_date} (#{before})"
+
+        e.each do |ev|
+          d = DateTime.parse(ev["starts_at_local"])
+
+          puts "Checking #{ev["starts_at_local"]} : #{d}"
+
+          d.should >= after
+          d.should < before
+        end
+      end
     end
 
     context "accesing the genre endpoint" do
@@ -497,6 +586,17 @@ describe "ThrillcallAPI" do
     end
 
     context "accesing the person endpoint" do
+      it "should be able to GET a person using ID" do
+        # Don't forget to change the credentials in your environment variables
+        params = {
+          :email    => PERSON_KNOWN_EMAIL,
+          :id       => PERSON_KNOWN_ID
+        }
+        mark_pending_if_nil_value(params)
+        p = @tc.person(params[:id])
+        (p["email"] || p["login"]).should == PERSON_KNOWN_EMAIL
+      end
+
       it "should be able to login a person using login/password credentials" do
         # Don't forget to change the credentials in your environment variables
         params = {
@@ -529,9 +629,19 @@ describe "ThrillcallAPI" do
         }
         mark_pending_if_nil_value(params)
         p = @tc.person.signup.post(params)
-        (p["email"] || p["login"]).should == PERSON_CREATE_EMAIL
+        p["first_name"].should == PERSON_CREATE_FIRSTNAME
       end
-      
+
+      it "should return a proper error message on failed login" do
+        params = {
+          :email    => PERSON_EMAIL,
+          :password => rand(1000000)
+        }
+        lambda {
+          p = @tc.person.signin.post(params)
+        }.should raise_error
+      end
+
       context "autoregistration for unknown provider/uid" do
         it "should be able to create a person using location name" do
           params = {
@@ -549,8 +659,7 @@ describe "ThrillcallAPI" do
 
           p = @tc.person.signin.post(params)
 
-          (p["email"] || p["login"]).should_not be_nil
-          (p["email"] || p["login"]).should == PERSON_UNKNOWN_EMAIL
+          p["first_name"].should == PERSON_CREATE_FIRSTNAME
         end
         
         it "should be able to create a person using (lat, long) for location" do
@@ -570,8 +679,7 @@ describe "ThrillcallAPI" do
 
           p = @tc.person.signin.post(params)
 
-          (p["email"] || p["login"]).should_not be_nil
-          (p["email"] || p["login"]).should == PERSON_UNKNOWN_EMAIL
+          p["first_name"].should == PERSON_CREATE_FIRSTNAME
         end
       end
     end

data/thrillcall-api.gemspec

@@ -15,16 +15,18 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "thrillcall-api"
 
   s.add_development_dependency  "bundler",                ">= 1.0.0"
+  s.add_development_dependency  "rake",                   "~> 0.9.2.2"
   s.add_development_dependency  "rspec",                  "~> 2.7.0"
   s.add_development_dependency  "ZenTest",                "~> 4.6.2"
   s.add_development_dependency  "autotest",               "~> 4.4.6"
   s.add_development_dependency  "autotest-growl",         "~> 0.2.16"
-  s.add_development_dependency  "autotest-fsevent",       "~> 0.2.7"
+  s.add_development_dependency  "autotest-fsevent",       "~> 0.2.8"
   s.add_development_dependency  "awesome_print",          "~> 1.0.1"
   s.add_development_dependency  "redcarpet",              "~> 1.17.2"
   s.add_development_dependency  "nokogiri",               "~> 1.4.6"
   s.add_development_dependency  "albino",                 "~> 1.3.3"
   s.add_development_dependency  "faker",                  "~> 0.9.5"
+  s.add_development_dependency  "tzinfo",                 "~> 0.3.31"
 
   s.add_dependency              "faraday",                "~> 0.7.0"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thrillcall-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70320976013600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,31 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70320976013600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320976013140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +55,15 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70320976013140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70320976012680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +71,15 @@ dependencies:
         version: 4.6.2
   type: :development
   prerelease: false
-  version_requirements: *70320976012680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.6.2
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &70320976012220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +87,15 @@ dependencies:
         version: 4.4.6
   type: :development
   prerelease: false
-  version_requirements: *70320976012220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.6
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70320976011760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,21 +103,31 @@ dependencies:
         version: 0.2.16
   type: :development
   prerelease: false
-  version_requirements: *70320976011760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.16
 - !ruby/object:Gem::Dependency
   name: autotest-fsevent
-  requirement: &70320976011300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.8
   type: :development
   prerelease: false
-  version_requirements: *70320976011300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70320976010840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -89,10 +135,15 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *70320976010840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70320976010380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -100,10 +151,15 @@ dependencies:
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *70320976010380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70320976009920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -111,10 +167,15 @@ dependencies:
         version: 1.4.6
   type: :development
   prerelease: false
-  version_requirements: *70320976009920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: albino
-  requirement: &70320976009460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,21 +183,47 @@ dependencies:
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *70320976009460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &70320976009000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.31
   type: :development
   prerelease: false
-  version_requirements: *70320976009000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.31
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70320976008540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -144,7 +231,12 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70320976008540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Simple wrapper around http://thrillcall.com's API
 email:
 - github@thrillcall.com
@@ -194,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: thrillcall-api
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Simple wrapper around http://thrillcall.com's API