lurch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41ee4ddf20b095a7e02065c4e5a7f6d4fc1d1dbc
-  data.tar.gz: 915497d9093ad580cc406a0c236fcd4b27029378
+  metadata.gz: c8fb6274173704bb0f17e22796c50ecbb4fe75b0
+  data.tar.gz: 06ee7c2aefa1d85d083520d5b008ed30b689e4b4
 SHA512:
-  metadata.gz: 42109bc7dda4b0b912b50176a90c8c2519b1e0978a5e7588144a261cff7bd42f078c2ce368d05246d7a77d266cced02f1db37399a867fa9ca0e694200b3b466c
-  data.tar.gz: ee3fb80f1f7b6ca88b62ae469348356db96ebd33a3558a1b1badf038624648950ee7e27e089128f9507bdb2cb83c0ae3e0b97beefc0943e9f1f0def3c8e91b88
+  metadata.gz: 5586c71bb63f79f4887ce86e18ce1884f55a680ec18e26f9a10be9a18405fc6f5b72c6f63200b554a5cb168d71fce8a4b63a6fddafb55f73a4fe5a8ffc056d2c
+  data.tar.gz: fa90e2c7b33df39e6d0c4e87b63471c770d109b56faca9d3bfa64ebf764077b5e472d393fb728c98f26fd75cca870d3904c60ee808954bba2add4ad837e998ab

data/CHANGELOG.md

@@ -6,7 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased][]
 
+## [0.2.0][] - 2017-11-04
+### Fixed
+-   Better error handling; server response status code is now always included in the exception message.
+-   Calling `fetch` on an already loaded collection will just return itself now instead of raising a `NoMethodError`
+
 ## 0.1.0 - 2017-10-30
 ### Initial public release
 
-[Unreleased]: https://github.com/peek-travel/cocktail/compare/0.1.0...HEAD
+[Unreleased]: https://github.com/peek-travel/cocktail/compare/0.2.0...HEAD
+[0.2.0]: https://github.com/peek-travel/cocktail/compare/0.1.0...0.2.0

data/README.md

@@ -10,7 +10,7 @@ A simple Ruby [JSON API](http://jsonapi.org/) client.
 Add this line to your application's Gemfile:
 
 ```
-gem 'lurch'
+gem "lurch", "~> 0.2"
 ```
 
 And then execute:

data/TODO.md

@@ -18,5 +18,5 @@
 * [ ] Yardoc documentation
 * [x] Add license
 * [x] Add changelog
-* [ ] Release 0.1.0 open source
+* [x] Release 0.1.0 open source
 * [x] Switch to codecov.io

data/lib/lurch/client.rb

@@ -8,8 +8,7 @@ module Lurch
       403 => Errors::Forbidden,
       404 => Errors::NotFound,
       409 => Errors::Conflict,
-      422 => Errors::UnprocessableEntity,
-      500 => Errors::ServerError
+      422 => Errors::UnprocessableEntity
     }.freeze
 
     def initialize(url, config)
@@ -68,12 +67,18 @@ module Lurch
     end
 
     def catch_errors(response)
-      raise STATUS_EXCEPTIONS[response.status], response.body if STATUS_EXCEPTIONS[response.status]
-      raise Errors::ServerError, response.body unless (200..299).cover?(response.status)
+      raise_error(STATUS_EXCEPTIONS[response.status], response) if STATUS_EXCEPTIONS[response.status]
+      raise_error(Errors::ClientError, response) if (400..499).cover?(response.status)
+      raise_error(Errors::ServerError, response) unless (200..299).cover?(response.status)
+      # TODO: handle 3xx
 
       response
     end
 
+    def raise_error(klass, response)
+      raise klass.new(response.body, response.status)
+    end
+
     def client
       @client ||= Faraday.new(url: url) do |conn|
         conn.headers[AUTHORIZATION] = authorization unless authorization.nil?

data/lib/lurch/errors/client_error.rb

@@ -0,0 +1,6 @@
+module Lurch
+  module Errors
+    class ClientError < JSONApiError
+    end
+  end
+end

data/lib/lurch/errors/json_api_error.rb

@@ -1,28 +1,33 @@
 module Lurch
   module Errors
     class JSONApiError < StandardError
-      def initialize(document)
+      attr_reader :status
+
+      def initialize(document, status)
         @document = document
+        @status = status
       end
 
       def message
-        return @document unless errors_document?
-        @document["errors"].map { |error| message_from_document_error(error) }.join(", ")
+        return "#{@status}: #{@document}" unless errors_document?
+
+        "#{@status}: #{errors_string}"
       end
 
       def errors
         return [] unless errors_document?
+
         @document["errors"].map { |error| Lurch::Error.new(error) }
       end
 
     private
 
       def errors_document?
-        @document.is_a?(Hash) && @document["errors"]
+        @document.is_a?(Hash) && @document["errors"].is_a?(Array)
       end
 
-      def message_from_document_error(error)
-        [*error["status"], *error["detail"]].join(": ")
+      def errors_string
+        @document["errors"].map { |error| error["detail"] }.join(", ")
       end
     end
   end

data/lib/lurch/version.rb

@@ -1,3 +1,3 @@
 module Lurch
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/lurch.rb

@@ -20,6 +20,7 @@ require "lurch/errors/forbidden"
 require "lurch/errors/not_found"
 require "lurch/errors/conflict"
 require "lurch/errors/unprocessable_entity"
+require "lurch/errors/client_error"
 require "lurch/errors/server_error"
 require "lurch/errors/not_loaded"
 require "lurch/errors/relationship_not_loaded"

data/test/helpers/response_factory.rb

@@ -20,6 +20,10 @@ class ResponseFactory
     header(:not_found) + errors_document([404, "Not Found"])
   end
 
+  def client_error_response
+    header(:teapot) + "I'm a teapot!"
+  end
+
   def unprocessable_entity_response(message)
     header(:unprocessable_entity) + errors_document([422, message])
   end
@@ -28,6 +32,10 @@ class ResponseFactory
     header(:server_error) + errors_document([500, "Internal Server Error"])
   end
 
+  def bad_server_error_response
+    header(:server_error) + "Oops! Something went wrong!"
+  end
+
   def person_response(id, name, phone_numbers_args = nil, code: :ok, include_phone_numbers: true)
     included = phone_numbers_args && include_phone_numbers ? phone_numbers_args.map { |args| phone_number_data(*args) } : []
     phone_number_ids = phone_numbers_args ? phone_numbers_args.map(&:first) : nil
@@ -171,6 +179,7 @@ private
     unauthorized: "401 Unauthorized".freeze,
     forbidden: "403 Forbidden".freeze,
     not_found: "404 Not Found".freeze,
+    teapot: "418 I'm a teapot".freeze,
     unprocessable_entity: "422 Unprocessable Entity".freeze,
     server_error: "500 Internal Server Error".freeze
   }.freeze

data/test/lurch/test_errors.rb

@@ -21,9 +21,21 @@ class TestErrors < Minitest::Test
     assert_equal "404: Not Found", err.message
   end
 
+  def test_418
+    stub_get("#{person_type}/1", @response_factory.client_error_response)
+    err = assert_raises(Lurch::Errors::ClientError) { @store.from(:people).find("1") }
+    assert_equal "418: I'm a teapot!", err.message
+  end
+
   def test_500
     stub_get("#{person_type}/1", @response_factory.server_error_response)
     err = assert_raises(Lurch::Errors::ServerError) { @store.from(:people).find("1") }
     assert_equal "500: Internal Server Error", err.message
   end
+
+  def test_unformatted_500
+    stub_get("#{person_type}/1", @response_factory.bad_server_error_response)
+    err = assert_raises(Lurch::Errors::ServerError) { @store.from(:people).find("1") }
+    assert_equal "500: Oops! Something went wrong!", err.message
+  end
 end

data/test/lurch/test_fetch_relationships.rb

@@ -41,6 +41,9 @@ class TestFetchRelationships < Minitest::Test
     person.phone_numbers.fetch
     phone_numbers = person.phone_numbers
 
+    # calling fetch again should not fail
+    person.phone_numbers.fetch
+
     assert_kind_of Lurch::Collection, phone_numbers
     assert_equal true, person.phone_numbers.loaded?
     assert_kind_of Lurch::Relationship::Linked, person.relationships[:phone_numbers]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lurch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Dosé
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -161,6 +161,7 @@ files:
 - lib/lurch/configuration.rb
 - lib/lurch/error.rb
 - lib/lurch/errors/bad_request.rb
+- lib/lurch/errors/client_error.rb
 - lib/lurch/errors/conflict.rb
 - lib/lurch/errors/forbidden.rb
 - lib/lurch/errors/json_api_error.rb