mirror-api 0.1.0 → 0.1.1

data/README.md

@@ -34,7 +34,7 @@ require "mirror-api"
 ```
 ### Authenticating your client
 ```ruby
-token = Mirror::OAuth.new(client_id, client_secret, refresh_token)
+token = Mirror::Api::OAuth.new(client_id, client_secret, refresh_token)
 
 api = Mirror::Api::Client.new(token)
 ```

data/lib/mirror-api/bad_request_error.rb

@@ -0,0 +1,14 @@
+module Mirror
+  module Api
+    class BadRequestError < RuntimeError
+
+      attr :details, :error
+
+      def initialize(error, details)
+        @error = error
+        @details = details
+      end
+
+    end
+  end
+end

data/lib/mirror-api/errors.rb

@@ -1,9 +1,12 @@
+require_relative "not_found_error"
+require_relative "bad_request_error"
+
 module Mirror
   module Api
     class Errors
-      ERROR_400 = {code: 1, :message => "Mirror API returned a status code 400 for this call"}
-      ERROR_404 = {code: 2, :message => "Mirror API returned a status code 404 for this call"}
-      INTERNAL_ERROR = {:code => 100, :message => "We are experiencing problems requesting your name. Our team has been notified."}
+      ERROR_400 = {code: 1, :message => "Mirror API returned a status code 400 for this call", :ex_class => Mirror::Api::BadRequestError}
+      ERROR_404 = {code: 2, :message => "Mirror API returned a status code 404 for this call", :ex_class => Mirror::Api::NotFoundError}
+      ERROR = {:code => 100, :message => "Mirror API returned an unexpected status code"}
       TOKEN_REFRESH_ERROR = {:code => 200, :message => "Could not refresh your API access token"}
     end
 end

data/lib/mirror-api/not_found_error.rb

@@ -0,0 +1,14 @@
+module Mirror
+  module Api
+    class NotFoundError < RuntimeError
+
+      attr :details, :error
+
+      def initialize(error, details)
+        @error = error
+        @details = details
+      end
+
+    end
+  end
+end

data/lib/mirror-api/request.rb

@@ -37,7 +37,7 @@ module Mirror
 
       def logger=(value)
         if value
-          if value.is_a?(Logger)
+          if value.respond_to?(:warn) && value.respond_to?(:error)
             @logger = value
           else
             raise "Invalid object given as logger #{value.inspect}"
@@ -96,10 +96,12 @@ module Mirror
       def handle_http_response(response, request, result, &block)
         @request = request
         case response.code
-          when 404
-          when 400
+          when 404, 400
+            @error_response = response.body
+            @error_code = response.code
+            @chosen_error = @error_code == 400 ? Mirror::Api::Errors::ERROR_400 : Mirror::Api::Errors::ERROR_404
             if @logger
-              msg = "ERROR - #{response.code} #{request.inspect} to #{self.invoke_url} with params #{self.params}. Response is #{response.body}"
+              msg = "ERROR - #{@error_code} #{request.inspect} to #{self.invoke_url} with params #{self.params}. Response is #{@error_response}"
               @logger.error(msg)
             end
             response
@@ -124,7 +126,7 @@ module Mirror
         if successful_response?
           ret_val
         else
-          send_error
+          @chosen_error ? send_chosen_error : send_error
         end
       end
 
@@ -134,7 +136,13 @@ module Mirror
         @last_error[:validation_error] = validation_error if validation_error
         msg += " with params #{params}"
         @logger.warn(msg) if @logger
-        raise error_desc[:message] if throw_on_fail
+        if throw_on_fail
+          if error_desc[:ex_class]
+            raise error_desc[:ex_class].new(@last_error, params)
+          else
+            raise error_desc[:message]
+          end
+        end
       end
 
       def set_data
@@ -185,11 +193,19 @@ module Mirror
 
       def send_error
         return handle_error(
-            Mirror::Api::Errors::ERROR_400,
+            Mirror::Api::Errors::ERROR,
             "Error making a request for #{@resource}",
             @data
         )
       end
+
+      def send_chosen_error
+        return handle_error(
+            @chosen_error,
+            "Error making a request for #{@resource}",
+            {:response => @error_response, :code => @error_code}
+        )
+      end
     end
   end
 end

data/lib/mirror-api/version.rb

@@ -1,5 +1,5 @@
 module Mirror
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/fixtures/subscriptions_insert_bad.json

@@ -0,0 +1,18 @@
+{
+  "error": {
+    "errors": [
+      {
+        "domain": "global",
+        "reason": "required",
+        "message": "collection field is required for Subscription"
+      },
+      {
+        "domain": "global",
+        "reason": "required",
+        "message": "callbackUrl field is required for Subscription"
+      }
+    ],
+    "code": 400,
+    "message": "collection field is required for Subscription"
+  }
+}

data/spec/spec_helper.rb

@@ -18,6 +18,11 @@ def fixture(file, read=false)
   file
 end
 
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
 def json_post_request_headers(token, body)
   {
       'Accept'=>'application/json',

data/spec/subscriptions_spec.rb

@@ -41,8 +41,8 @@ describe "Subscriptions" do
 
       context "bubbling errors" do
         it "should raise ex" do
-          @api = Mirror::Api::Client.new(@token, true)
-          expect{@api.subscriptions.delete(@id)}.to raise_error
+          @api = Mirror::Api::Client.new(@token, raise_errors: true)
+          expect{@api.subscriptions.delete(@id)}.to raise_error(Mirror::Api::BadRequestError)
         end
       end
     end
@@ -75,20 +75,20 @@ describe "Subscriptions" do
         stub_request(:post, "https://www.googleapis.com/mirror/v1/subscriptions/").
             with(body: @body2,
                  headers: json_post_request_headers(@token, @body2.to_json)).
-            to_return(status: 404,
-                      body: {},
+            to_return(status: 400,
+                      body: fixture("subscriptions_insert_bad.json", true),
                       headers: {})
       end
       it "should return nil" do
         @api = Mirror::Api::Client.new(@token)
-        subscription = @api.subscriptions.insert({not_cool_dude: "Really you thought that was valid?!"})
+        subscription = @api.subscriptions.insert(@body2)
         subscription.should == nil
       end
 
       context "bubbling errors" do
         it "should raise ex" do
           @api = Mirror::Api::Client.new(@token, {:raise_errors => true})
-          expect{@api.subscriptions.insert(@body)}.to raise_error
+          expect{@api.subscriptions.insert(@body2)}.to raise_error(Mirror::Api::BadRequestError)
         end
       end
     end
@@ -161,7 +161,7 @@ describe "Subscriptions" do
 
         it "should raise an exception" do
           @api = Mirror::Api::Client.new(@token, {:raise_errors => true})
-          expect{@api.subscriptions.update(@id, @body)}.to raise_error
+          expect{@api.subscriptions.update(@id, @body)}.to raise_error(Mirror::Api::BadRequestError)
         end
       end
     end

data/spec/timeline_attachments_spec.rb

@@ -130,7 +130,7 @@ describe "Timeline Attachments" do
                       headers: {})
       end
 
-      it "should return a list of contacts", :focus => true do
+      it "should return a list of contacts" do
         attachments = @api.timeline.list(@timeline_id, {attachments: {} })
         attachments.should_not be_nil
         attachments.items.count.should == 2  # see fixture

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mirror-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -205,8 +205,10 @@ files:
 - Rakefile
 - example/.gitkeep
 - lib/mirror-api.rb
+- lib/mirror-api/bad_request_error.rb
 - lib/mirror-api/client.rb
 - lib/mirror-api/errors.rb
+- lib/mirror-api/not_found_error.rb
 - lib/mirror-api/oauth.rb
 - lib/mirror-api/request.rb
 - lib/mirror-api/request_data.rb
@@ -222,6 +224,7 @@ files:
 - spec/fixtures/locations_item.json
 - spec/fixtures/locations_list.json
 - spec/fixtures/oauth_response.json
+- spec/fixtures/subscriptions_insert_bad.json
 - spec/fixtures/subscriptions_item.json
 - spec/fixtures/subscriptions_list.json
 - spec/fixtures/timeline_item.json
@@ -270,6 +273,7 @@ test_files:
 - spec/fixtures/locations_item.json
 - spec/fixtures/locations_list.json
 - spec/fixtures/oauth_response.json
+- spec/fixtures/subscriptions_insert_bad.json
 - spec/fixtures/subscriptions_item.json
 - spec/fixtures/subscriptions_list.json
 - spec/fixtures/timeline_item.json