jsonapi-consumer 0.1.0.pre.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c1023158bad9c3f878f6c70c43de0030f33548f
-  data.tar.gz: e00a070c00e6dc4f013b7acb976fa38a3dab2b4d
+  metadata.gz: 2ebd6ed496bf4e33e58103e89a8ea1f8ec65e49c
+  data.tar.gz: 4de1a846349a7e3606f45573fa70dd8c2b60bbdd
 SHA512:
-  metadata.gz: 576270b931a52c0b2813bd09a86a0352cd4b1ca9961ec4ed1cd923fc8f6a09076d03acd6879758c9c7c56f71851fba863cf53effd68b22c9a160adceafad2302
-  data.tar.gz: b8f8db8bb78d3dfd10c7b56206cf2419962a36a3c15c7f0f9ff0f9bb246bab4ecc8f9961a0c308de4ebb23f89669409c1c0b363999a8a0c04f063470b6bd9fbf
+  metadata.gz: f90b5cf975914fdc9dced9176b48e8705f98c3ee8b423c653629aa76513e11b3615ed7e771f4bd54c58416198ad5073198b955a9bd8e379672c5fde8b5fa9ec6
+  data.tar.gz: 25da9ee3afd9b759a001834fb4989aeb73c1e6a8c0cfc59cecd51bd09fa1a17ac33350618db264089108a9fa7cacd68aef81f2a6f5c79fa0e602aab0cd5bb32b

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 
+0.1.0 / 2014-12-03
+==================
+
+  * `middleware` and `ssl` attributes are inheritable
+  * Support custom faraday connection middleware with `#middleware` block
+  * update README with usage
+
 0.1.0.pre.3 / 2014-11-11
 ==================
 

data/README.md

@@ -22,7 +22,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+It's suggested to create a base resource for the whole API that you can re-use.
+
+```ruby
+class Base
+  include JSONAPI::Consumer::Resource
+
+  self.host = 'http://localhost:3000/api/'
+end
+```
+
+Then inherit from that Base class for each resource defined in your API.
+
+```ruby
+module Blog
+
+  class Author < Base
+    has_many :posts, class_name: 'Blog::Post'
+  end
+
+  class Post < Base
+    has_one :user, class_name: 'Blog::User'
+    has_many :comments, class_name: 'Blog::Comment'
+  end
+
+  class User < Base
+
+  end
+
+  class Comment < Base
+
+  end
+
+end
+```
+
+#### Additional Features
+
+##### Dynamic Objects
+
+By default calling `.new` or `.build` on a resource will give you an empty
+object with no attributes defined. This is less than ideal when building forms
+with something like Rails' FormBuilder.
+
+We suggest setting up your model to do a `GET /{resource_name}/new` if your
+server supports it and using `.build` instead of `.new`. This will populate the
+object with defaults set by the server response.
+
+```ruby
+class User
+  include JSONAPI::Consumer::Resource
+
+  self.request_new_object_on_build = true
+
+  # .build will now call GET /users/new
+end
+```
+
+#### Testing
+
+We suggest [Webmock](https://github.com/bblimke/webmock) at this stage in
+development. We plan to add test helpers before the first major release.
 
 ## Contributing
 

data/lib/jsonapi/consumer/resource.rb

@@ -6,7 +6,7 @@ module JSONAPI::Consumer
       extend ActiveModel::Naming
 
       attr_reader :errors
-      class_attribute :host
+      class_attribute :host, :connection, :ssl
     end
 
     include ObjectBuildConcern
@@ -17,6 +17,10 @@ module JSONAPI::Consumer
     include ConnectionConcern
 
     module ClassMethods
+      def middleware(&block)
+        _connection(true, &block)
+      end
+
       def json_key
         self.name.demodulize.pluralize.underscore
       end

data/lib/jsonapi/consumer/resource/connection_concern.rb

@@ -23,18 +23,22 @@ module JSONAPI::Consumer
       end
 
       # :nodoc:
-      def _connection
-        @connection ||= begin
+      def _connection(reload=false)
+        self.connection = nil if !!reload
+        self.connection ||= begin
           Faraday.new(url: self.host, ssl: self.ssl) do |conn|
             conn.request :json
             conn.request :request_headers, accept: "application/json"
 
+            yield(conn) if block_given?
+
             conn.use Middleware::RequestTimeout
             conn.use Middleware::ParseJson
 
             conn.use Middleware::RaiseError
             conn.adapter Faraday.default_adapter
           end
+
         end
       end
     end

data/lib/jsonapi/consumer/version.rb

@@ -1,5 +1,5 @@
 module Jsonapi
   module Consumer
-    VERSION = "0.1.0.pre.3"
+    VERSION = "0.1.0"
   end
 end

data/spec/fixtures/resources.rb

@@ -35,3 +35,11 @@ module Blog
   end
 end
 # END - Blog example
+
+
+class NotCalled < Faraday::Response::Middleware
+  class ::NotCalledError < StandardError; end
+  def parse(body)
+    raise NotCalledError, "this should not be called"
+  end
+end

data/spec/jsonapi/consumer/connection_spec.rb

@@ -10,6 +10,27 @@ RSpec.describe 'Connection' do
 
   let(:obj) { test_class.new(name: 'jsonapi.example') }
 
+  describe 'custom connection middleware' do
+
+    it 'handles custom middleware' do
+      stub_request(:get, "http://localhost:3000/api/basic_resources")
+        .with(headers: {accept: 'application/json'})
+        .to_return(headers: {content_type: "application/json"}, body: {
+          basic_resources: [
+            {id: '1'}
+          ]
+        }.to_json)
+
+      expect { BasicResource.all }.to_not raise_error
+
+      BasicResource.middleware do |conn|
+        conn.use NotCalled
+      end
+
+      expect { BasicResource.all }.to raise_error(NotCalledError)
+    end
+  end
+
   describe '.all' do
     it 'returns all results as objects' do
       stub_request(:get, "http://localhost:3000/api/records")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Smestad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -217,9 +217,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2