etsy 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d8467d59605302ecbe6fa8a5c2c78fae8435b2b
-  data.tar.gz: 9f78e9dd4514d505d5738b19ebc9724184ce6259
+  metadata.gz: c0417646d0a3bad8aac70e2fe86cf6904fd5803b
+  data.tar.gz: ce49ace0289086a486b2e1a0185232bb444653cb
 SHA512:
-  metadata.gz: 80ab0008d0d4087c40b5045a9a38c46a50a4232b6d37e6062e162143641aad1893fc3ce1340f0e3825dabbcfc576312697f3600fd660331039bc1c001cb5418a
-  data.tar.gz: f7e5fd820fe67797cb8c180ad5f91d58672d9fa7ccbe05cf5766480cfada9c72579dc4637b574badb099999ec9c49f03d736b4891472a01cbc75f9a9dad31fc4
+  metadata.gz: 41647ccad160295f3fd4143db22264b3f051c45b7d9254ceabcc8ae65ae130d571a3eae7f2500752fedbcb408d1b05e51e0966ba0f4643091ff211f384c4726d
+  data.tar.gz: a9d658cc135a7acdb17b55a086b3c65fdf378afb538c7fc7a4b97f2996d9369604f5dd7b78d95706c248e76649459b8b25b1422d7b3066df100dacdac65b5e6d

data/.travis.yml

@@ -4,5 +4,4 @@ rvm:
   - 1.9.3
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2

data/README.md

@@ -45,7 +45,6 @@ The Etsy API has support for both retrieval of extended information and write su
 
 For simple authentication from the console, configure the necessary parameters:
 
-    require 'rubygems'
     require 'etsy'
 
     Etsy.api_key = 'key'
@@ -72,7 +71,6 @@ Authenticated calls can now be made by passing an access token and secret:
 
 The process for authenticating via a web application is similar, but requires the configuration of a callback URL:
 
-    require 'rubygems'
     require 'etsy'
 
     Etsy.api_key = 'key'
@@ -102,14 +100,21 @@ to the verification URL. A simple example using Sinatra:
 
 ### Environment
 
-The Etsy API has both a sandbox environment and a production environment.
+The Etsy API previously had both a sandbox environment and a production environment. They have recently eliminated the sandbox environment, but the ability to set the environment has been preserved in case it is implemented in v3.
 
-If nothing is set, the default is :sandbox.
+If nothing is set, the default is :production.
 
 You can set this using:
 
     Etsy.environment = :production
 
+## Error handling
+
+For legacy reasons, this gem does *not* raise errors when requests are unsuccessful.
+However, you can force errors to be thrown by configuring the `silent_errors` flag.
+
+    >>> Etsy.silent_errors = false
+
 ## DSL
 
 Use the Etsy::Request class to make flexible calls to the API.
@@ -223,7 +228,7 @@ If you want a more fine-grained response, you can specify the associations as an
 
 ## Public mode vs authenticated calls
 
-This additional example should make clear the difference between issuing public versus authenticated requests: 
+This additional example should make clear the difference between issuing public versus authenticated requests:
 
 ### Public workflow
 
@@ -238,46 +243,7 @@ This additional example should make clear the difference between issuing public
     >> user = Etsy.myself(token, secret)
 	>> access = { :access_token => user.token, :access_secret => user.secret }
 	>> Etsy::Listing.find_all_by_shop_id(user.shop.id, access.merge(:limit => 5))
-	
-## Error handling
-
-Next versions of this gem will raise errors when requests are unsuccessful. The current version does not. 
-Use either of following workarounds:
-
-### Low-level API
-
-Instead of doing this:
-
-    >> Etsy::Request.get('/users/__SELF__', access).result 
-
-Write this:
-
-    >> Etsy::Request.get('/users/__SELF__', access).to_hash["results"]
-
-### Monkey patch
-
-This is Ruby, reopen the <code>Response</code> class anywhere in your codebase and redefine <code>result</code>:
-
-      class Etsy::Response
-        def result
-	      if success?
-	        results = to_hash['results'] || []
-	        count == 1 ? results.first : results
-	      else
-	       validate!
-	      end
-        end
-      end
-
-### Usage
-
-With the above in place, you can now rescue errors and act upon them:
 
-      begin
-        Etsy.myself(access.token, access.secret)		
-      rescue Etsy::OAuthTokenRevoked, Etsy::InvalidUserID, Etsy::MissingShopID, Etsy::EtsyJSONInvalid, Etsy::TemporaryIssue => e
-        puts e.message
-      end 
 
 ## Contributing
 
@@ -321,6 +287,7 @@ These people have helped make the Etsy gem what it is today:
 * [Jimmy Tang](https://github.com/jimmytang)
 * [Julio Santos](https://github.com/julio)
 * [Roger Smith](https://github.com/rogsmith)
+* [Daniel Szmulewicz](https://github.com/danielsz)
 
 ### Github Flow
 

data/lib/etsy/response.rb

@@ -2,11 +2,18 @@ module Etsy
 
   class OAuthTokenRevoked < StandardError; end
   class MissingShopID < StandardError; end
-  class EtsyJSONInvalid < StandardError; end
   class TemporaryIssue < StandardError; end
   class ResourceUnavailable < TemporaryIssue; end
   class ExceededRateLimit < TemporaryIssue; end
   class InvalidUserID < StandardError; end
+  class EtsyJSONInvalid < StandardError
+    attr_reader :code, :data
+    def initialize(args)
+      @code = args[:code]
+      @data = args[:data]
+    end  
+  end
+
 
   # = Response
   #
@@ -48,7 +55,7 @@ module Etsy
         results = to_hash['results'] || []
         count == 1 ? results.first : results
       else
-        []
+        Etsy.silent_errors ? [] : validate!
       end
     end
     
@@ -82,7 +89,7 @@ module Etsy
       raise TemporaryIssue            if temporary_etsy_issue?
       raise ResourceUnavailable       if resource_unavailable?
       raise ExceededRateLimit         if exceeded_rate_limit?
-      raise EtsyJSONInvalid.new("CODE: #{code}, BODY: #{data}") unless valid_json?
+      raise EtsyJSONInvalid.new({:code => code, :data => data}) unless valid_json?
       true
     end
 

data/lib/etsy/version.rb

@@ -1,3 +1,3 @@
 module Etsy
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/etsy.rb

@@ -67,20 +67,24 @@ module Etsy
     attr_writer :permission_scopes
   end
 
-  # Make Etsy.api_key and Etsy.api_secret thread safe
+  # Make Etsy.api_key and Etsy.api_secret global but also local to threads
   #
   def self.api_key
-    Thread.current[:etsy_api_key]
+    Thread.current[:etsy_api_key] || @api_key
   end
 
-  def self.api_key=(val)
-    Thread.current[:etsy_api_key] = val
+  def self.api_key=(key)
+    @api_key ||= key
+    Thread.current[:etsy_api_key] = key
   end
+
   def self.api_secret
-    Thread.current[:etsy_api_secret]
+    Thread.current[:etsy_api_secret] || @api_secret
   end
-  def self.api_secret=(val)
-    Thread.current[:etsy_api_secret] = val
+  
+  def self.api_secret=(secret)
+    @api_secret ||= secret
+    Thread.current[:etsy_api_secret] = secret
   end
 
   SANDBOX_HOST = 'sandbox.openapi.etsy.com'
@@ -104,6 +108,15 @@ module Etsy
     @protocol = protocol.to_s
   end
   
+  # Allow throwing API errors
+  #
+  def self.silent_errors=(bool)
+    unless [TrueClass, FalseClass].include?(bool.class)
+      raise(ArgumentError, "Silent errors must be set to either true or false'")
+    end
+    @silent_errors = bool
+  end
+
   def self.protocol
     @protocol || "https"
   end
@@ -111,11 +124,17 @@ module Etsy
   # The currently configured environment.
   #
   def self.environment
-    @environment || :sandbox
+    @environment || :production
+  end
+
+  # The default will change to false for a 1.0 release (breaking changes)
+  #
+  def self.silent_errors
+    @silent_errors.nil? ? true : @silent_errors
   end
 
   def self.host # :nodoc:
-    @host || SANDBOX_HOST
+    @host || PRODUCTION_HOST
   end
 
   # The configured callback URL or 'oob' if no callback URL is configured. This controls

data/test/unit/etsy/response_test.rb

@@ -80,8 +80,9 @@ module Etsy
         raw_response.stubs(:body => "I am not JSON", :code => 500)
         r = Response.new(raw_response)
 
-        lambda { r.to_hash }.should raise_error(Etsy::EtsyJSONInvalid)
-        lambda { r.to_hash }.should raise_error("CODE: 500, BODY: I am not JSON")
+        exception = assert_raises(Etsy::EtsyJSONInvalid) { r.to_hash }
+        assert_equal( 500, exception.code )
+        assert_equal( "I am not JSON", exception.data )
       end
 
       should "raise OAuthTokenRevoked" do

data/test/unit/etsy_test.rb

@@ -12,6 +12,7 @@ class EtsyTest < Test::Unit::TestCase
       Etsy.instance_variable_set(:@api_key, nil)
       Etsy.instance_variable_set(:@api_secret, nil)
       Etsy.instance_variable_set(:@permission_scopes, nil)
+      Etsy.instance_variable_set(:@silent_errors, nil)
     end
 
     should "be able to set and retrieve the API key" do
@@ -19,6 +20,41 @@ class EtsyTest < Test::Unit::TestCase
       Etsy.api_key.should == 'key'
     end
 
+    should "be able to set and retrieve the API key across threads (global)" do
+      Etsy.api_key = 'key'
+      Thread.new do
+        Etsy.api_key.should == 'key'
+      end.join
+    end
+
+    should "be able to set and retrieve the API key inside a thread (thread local)" do
+      Etsy.api_key = 'key'
+      Thread.new do
+        Etsy.api_key = 'thread_local_key'
+        Etsy.api_key.should == 'thread_local_key'
+      end.join
+    end
+
+    should "be able to set and retrieve the API secret" do
+      Etsy.api_secret = 'secret'
+      Etsy.api_secret.should == 'secret'
+    end
+
+    should "be able to set and retrieve the API secret across threads (global)" do
+      Etsy.api_secret = 'secret'
+      Thread.new do
+        Etsy.api_secret.should == 'secret'
+      end.join
+    end
+
+    should "be able to set and retrieve the API secret inside a thread (thread local)" do
+      Etsy.api_secret = 'secret'
+      Thread.new do
+        Etsy.api_secret = 'thread_local_secret'
+        Etsy.api_secret.should == 'thread_local_secret'
+      end.join
+    end
+
     should "be able to find a user by username" do
       user = stub()
 
@@ -39,22 +75,30 @@ class EtsyTest < Test::Unit::TestCase
       lambda { Etsy.protocol = :invalid }.should raise_error(ArgumentError)
     end
 
-    should "use the sandbox environment by default" do
-      Etsy.environment.should == :sandbox
+    should "use silent errors by default" do
+      Etsy.silent_errors.should == true
     end
 
-    should "be able to set the environment to a valid value" do
-      Etsy.environment = :production
+    should "be able to set silent errors to a valid value" do
+      Etsy.silent_errors = false
+      Etsy.silent_errors.should == false
+    end
+
+    should "raise an exception when attempting to set an invalid silent errors value" do
+      lambda { Etsy.silent_errors = :invalid }.should raise_error(ArgumentError)
+    end
+
+    should "use the production environment by default" do
       Etsy.environment.should == :production
     end
 
-    should "raise an exception when attempting to set an invalid environment" do
-      lambda { Etsy.environment = :invalid }.should raise_error(ArgumentError)
+    should "be able to set the environment to a valid value" do
+      Etsy.environment = :sandbox
+      Etsy.environment.should == :sandbox
     end
 
-    should "be able to set and retrieve the API secret" do
-      Etsy.api_secret = 'secret'
-      Etsy.api_secret.should == 'secret'
+    should "raise an exception when attempting to set an invalid environment" do
+      lambda { Etsy.environment = :invalid }.should raise_error(ArgumentError)
     end
 
     should "know the host for the sandbox environment" do
@@ -67,8 +111,8 @@ class EtsyTest < Test::Unit::TestCase
       Etsy.host.should == 'openapi.etsy.com'
     end
 
-    should "default to sandbox host" do
-      Etsy.host.should == 'sandbox.openapi.etsy.com'
+    should "default to production host" do
+      Etsy.host.should == 'openapi.etsy.com'
     end
 
     should "be able to set the callback url" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etsy
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Patrick Reagan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provides a friendly ruby-like wrapper for the Etsy API
@@ -268,3 +268,4 @@ test_files:
 - test/unit/etsy/user_test.rb
 - test/unit/etsy/verification_request_test.rb
 - test/unit/etsy_test.rb
+has_rdoc: