her 0.8.1 → 0.8.3

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 sudo: false
 
 rvm:
+  - 2.3.1
   - 2.2.2
   - 2.1.6
   - 2.0.0

data/README.md

@@ -1,3 +1,9 @@
+# Maintenance Update 29th Sept 2016
+Hi folks, [@edtjones](https://github.com/edtjones) here. Rémi has handed me the keys to Her and [@foxpaul](https://github.com/foxpaul) and I will be trying to do the library justice with the help of the community. There's loads to do; we'll get in touch with everyone who's raised a PR as soon as possible and figure out a plan of action.
+
+# Rails 5 support
+If you need Rails 5 support, version 0.8.2 is for you!
+
 <p align="center">
   <a href="https://github.com/remiprev/her">
     <img src="http://i.imgur.com/43KEchq.png" alt="Her" />

data/UPGRADE.md

@@ -2,7 +2,7 @@
 
 Here is a list of notable changes by release. Her follows the [Semantic Versioning](http://semver.org/) system.
 
-## 0.8.0
+## 0.8.1 (Note: 0.8.0 yanked)
 
 - Initial support for JSONAPI [link](https://github.com/remiprev/her/pull/347)
 - Fix for has_one association parsing [link](https://github.com/remiprev/her/pull/352)

data/her.gemspec

@@ -18,13 +18,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 2.13"
-  s.add_development_dependency "rspec-its", "~> 1.0"
-  s.add_development_dependency "fivemat", "~> 1.2"
+  s.add_development_dependency "rspec", "~> 3.5"
   s.add_development_dependency "json", "~> 1.8"
 
-  s.add_runtime_dependency "activemodel", ">= 3.0.0", "<= 4.3.0"
-  s.add_runtime_dependency "activesupport", ">= 3.0.0", "<= 4.3.0"
+  s.add_runtime_dependency "activemodel", ">= 3.0.0", "<= 6.0.0"
+  s.add_runtime_dependency "activesupport", ">= 3.0.0", "<= 6.0.0"
   s.add_runtime_dependency "faraday", ">= 0.8", "< 1.0"
   s.add_runtime_dependency "multi_json", "~> 1.7"
 end

data/lib/her/model/associations/association_proxy.rb

@@ -33,8 +33,7 @@ module Her
           end
 
           # create a proxy to the fetched object's method
-          metaclass = (class << self; self; end)
-          metaclass.install_proxy_methods 'association.fetch', name
+          AssociationProxy.install_proxy_methods 'association.fetch', name
 
           # resend message to fetched object
           __send__(name, *args, &block)

data/lib/her/model/orm.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 module Her
   module Model
     # This module adds ORM-like capabilities to the model
@@ -72,10 +73,10 @@ module Her
       #   @user = User.find(1)
       #   @user.destroy
       #   # Called via DELETE "/users/1"
-      def destroy
+      def destroy(params = {})
         method = self.class.method_for(:destroy)
         run_callbacks :destroy do
-          self.class.request(:_method => method, :_path => request_path) do |parsed_data, response|
+          self.class.request(params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
             assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
             @metadata = parsed_data[:metadata]
             @response_errors = parsed_data[:errors]
@@ -159,7 +160,10 @@ module Her
         #   # Called via DELETE "/users/1"
         def destroy_existing(id, params={})
           request(params.merge(:_method => method_for(:destroy), :_path => build_request_path(params.merge(primary_key => id)))) do |parsed_data, response|
-            new(parse(parsed_data[:data]).merge(:_destroyed => true))
+            data = parse(parsed_data[:data])
+            metadata = parsed_data[:metadata]
+            response_errors = parsed_data[:errors]
+            new(data.merge(:_destroyed => true, :metadata => metadata, :response_errors => response_errors))
           end
         end
 

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.8.1"
+  VERSION = "0.8.3"
 end

data/spec/api_spec.rb

@@ -8,21 +8,24 @@ describe Her::API do
     describe "#setup" do
       context "when setting custom middleware" do
         before do
-          class Foo; end;
-          class Bar; end;
+          class Foo; end
+          class Bar; end
 
-          subject.setup :url => "https://api.example.com" do |connection|
+          subject.setup url: "https://api.example.com" do |connection|
             connection.use Foo
             connection.use Bar
           end
         end
 
-        specify { subject.connection.builder.handlers.should == [Foo, Bar] }
+        specify { expect(subject.connection.builder.handlers).to eq([Foo, Bar]) }
       end
 
       context "when setting custom options" do
-        before { subject.setup :foo => { :bar => "baz" }, :url => "https://api.example.com" }
-        its(:options) { should == { :foo => { :bar => "baz" }, :url => "https://api.example.com" } }
+        before { subject.setup foo: { bar: "baz" }, url: "https://api.example.com" }
+
+        describe "#options" do
+          it { expect(subject.options).to eq(foo: { bar: "baz" }, url: "https://api.example.com") }
+        end
       end
     end
 
@@ -30,83 +33,83 @@ describe Her::API do
       before do
         class SimpleParser < Faraday::Response::Middleware
           def on_complete(env)
-            env[:body] = { :data => env[:body] }
+            env[:body] = { data: env[:body] }
           end
         end
       end
 
       context "making HTTP requests" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "/foo")[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "/foo")[:parsed_data] }
         before do
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use SimpleParser
-            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is."] } }
+            builder.adapter(:test) { |stub| stub.get("/foo") { [200, {}, "Foo, it is."] } }
           end
         end
 
-        specify { parsed_data[:data].should == "Foo, it is." }
+        specify { expect(parsed_data[:data]).to eq("Foo, it is.") }
       end
 
       context "making HTTP requests while specifying custom HTTP headers" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "/foo", :_headers => { "X-Page" => 2 })[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "/foo", _headers: { "X-Page" => 2 })[:parsed_data] }
 
         before do
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use SimpleParser
-            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is page #{env[:request_headers]["X-Page"]}."] } }
+            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is page #{env[:request_headers]['X-Page']}."] } }
           end
         end
 
-        specify { parsed_data[:data].should == "Foo, it is page 2." }
+        specify { expect(parsed_data[:data]).to eq("Foo, it is page 2.") }
       end
 
       context "parsing a request with the default parser" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "users/1")[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
         before do
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use Her::Middleware::FirstLevelParseJSON
             builder.adapter :test do |stub|
-              stub.get("/users/1") { |env| [200, {}, MultiJson.dump({ :id => 1, :name => "George Michael Bluth", :errors => ["This is a single error"], :metadata => { :page => 1, :per_page => 10 } })] }
+              stub.get("/users/1") { [200, {}, MultiJson.dump(id: 1, name: "George Michael Bluth", errors: ["This is a single error"], metadata: { page: 1, per_page: 10 })] }
             end
           end
         end
 
         specify do
-          parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
-          parsed_data[:errors].should == ["This is a single error"]
-          parsed_data[:metadata].should == { :page => 1, :per_page => 10 }
+          expect(parsed_data[:data]).to eq(id: 1, name: "George Michael Bluth")
+          expect(parsed_data[:errors]).to eq(["This is a single error"])
+          expect(parsed_data[:metadata]).to eq(page: 1, per_page: 10)
         end
       end
 
       context "parsing a request with a custom parser" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "users/1")[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
         before do
           class CustomParser < Faraday::Response::Middleware
             def on_complete(env)
-              json = MultiJson.load(env[:body], :symbolize_keys => true)
+              json = MultiJson.load(env[:body], symbolize_keys: true)
               errors = json.delete(:errors) || []
               metadata = json.delete(:metadata) || {}
               env[:body] = {
-                :data => json,
-                :errors => errors,
-                :metadata => metadata,
+                data: json,
+                errors: errors,
+                metadata: metadata
               }
             end
           end
 
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use CustomParser
             builder.use Faraday::Request::UrlEncoded
             builder.adapter :test do |stub|
-              stub.get("/users/1") { |env| [200, {}, MultiJson.dump(:id => 1, :name => "George Michael Bluth")] }
+              stub.get("/users/1") { [200, {}, MultiJson.dump(id: 1, name: "George Michael Bluth")] }
             end
           end
         end
 
         specify do
-          parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
-          parsed_data[:errors].should == []
-          parsed_data[:metadata].should == {}
+          expect(parsed_data[:data]).to eq(id: 1, name: "George Michael Bluth")
+          expect(parsed_data[:errors]).to eq([])
+          expect(parsed_data[:metadata]).to eq({})
         end
       end
     end

data/spec/collection_spec.rb

@@ -1,26 +1,41 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Her::Collection do
-
   let(:items) { [1, 2, 3, 4] }
-  let(:metadata) { { :name => 'Testname' } }
-  let(:errors) { { :name => ['not_present'] } }
+  let(:metadata) { { name: "Testname" } }
+  let(:errors) { { name: ["not_present"] } }
 
   describe "#new" do
     context "without parameters" do
       subject { Her::Collection.new }
 
-      it { should eq([]) }
-      its(:metadata) { should eq({}) }
-      its(:errors) { should eq({}) }
+      it { is_expected.to eq([]) }
+
+      describe "#metadata" do
+        subject { super().metadata }
+        it { is_expected.to eq({}) }
+      end
+
+      describe "#errors" do
+        subject { super().errors }
+        it { is_expected.to eq({}) }
+      end
     end
 
     context "with parameters" do
       subject { Her::Collection.new(items, metadata, errors) }
 
-      it { should eq([1,2,3,4]) }
-      its(:metadata) { should eq({ :name => 'Testname' }) }
-      its(:errors) { should eq({ :name => ['not_present'] }) }
+      it { is_expected.to eq([1, 2, 3, 4]) }
+
+      describe "#metadata" do
+        subject { super().metadata }
+        it { is_expected.to eq(name: "Testname") }
+      end
+
+      describe "#errors" do
+        subject { super().errors }
+        it { is_expected.to eq(name: ["not_present"]) }
+      end
     end
   end
 end

data/spec/json_api/model_spec.rb

@@ -1,163 +1,166 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Her::JsonApi::Model do
   before do
-    Her::API.setup :url => "https://api.example.com" do |connection|
+    Her::API.setup url: "https://api.example.com" do |connection|
       connection.use Her::Middleware::JsonApiParser
       connection.adapter :test do |stub|
-        stub.get("/users/1") do |env| 
-          [ 
+        stub.get("/users/1") do
+          [
             200,
             {},
             {
               data: {
                 id:    1,
-                type: 'users',
+                type: "users",
                 attributes: {
-                  name: "Roger Federer",
-                },
+                  name: "Roger Federer"
+                }
               }
-              
+
             }.to_json
-          ] 
+          ]
         end
 
-        stub.get("/users") do |env| 
-          [ 
+        stub.get("/users") do
+          [
             200,
             {},
             {
               data: [
                 {
                   id:    1,
-                  type: 'users',
+                  type: "users",
                   attributes: {
-                    name: "Roger Federer",
-                  },
-                }, 
+                    name: "Roger Federer"
+                  }
+                },
                 {
                   id:    2,
-                  type: 'users',
+                  type: "users",
                   attributes: {
-                    name: "Kei Nishikori",
-                  },
+                    name: "Kei Nishikori"
+                  }
                 }
               ]
             }.to_json
-          ] 
+          ]
         end
 
-        stub.post("/users", data: {
-          type: 'users',
+        stub.post("/users", data:
+        {
+          type: "users",
           attributes: {
-            name: "Jeremy Lin",
-          },
-        }) do |env|
-          [ 
+            name: "Jeremy Lin"
+          }
+        }) do
+          [
             201,
             {},
             {
               data: {
                 id:    3,
-                type: 'users',
+                type: "users",
                 attributes: {
-                  name: 'Jeremy Lin',
-                },
+                  name: "Jeremy Lin"
+                }
               }
-              
+
             }.to_json
-          ] 
+          ]
         end
 
-        stub.patch("/users/1", data: {
-          type: 'users',
+        stub.patch("/users/1", data:
+        {
+          type: "users",
           id: 1,
           attributes: {
-            name: "Fed GOAT",
-          },
-        }) do |env|
-          [ 
+            name: "Fed GOAT"
+          }
+        }) do
+          [
             200,
             {},
             {
               data: {
                 id:    1,
-                type: 'users',
+                type: "users",
                 attributes: {
-                  name: 'Fed GOAT',
-                },
+                  name: "Fed GOAT"
+                }
               }
-              
+
             }.to_json
-          ] 
+          ]
         end
 
-        stub.delete("/users/1") { |env|
-          [ 204, {}, {}, ] 
-        }
+        stub.delete("/users/1") do
+          [204, {}, {}]
+        end
       end
-
     end
 
     spawn_model("Foo::User", type: Her::JsonApi::Model)
   end
 
-  it 'allows configuration of type' do
+  it "allows configuration of type" do
     spawn_model("Foo::Bar", type: Her::JsonApi::Model) do
       type :foobars
     end
 
-    expect(Foo::Bar.instance_variable_get('@type')).to eql('foobars')
+    expect(Foo::Bar.instance_variable_get("@type")).to eql("foobars")
   end
 
-  it 'finds models by id' do
+  it "finds models by id" do
     user = Foo::User.find(1)
     expect(user.attributes).to eql(
-      'id' => 1,
-      'name' => 'Roger Federer',
+      "id" => 1,
+      "name" => "Roger Federer"
     )
   end
 
-  it 'finds a collection of models' do
+  it "finds a collection of models" do
     users = Foo::User.all
-    expect(users.map(&:attributes)).to match_array([
-      {
-        'id' => 1,
-        'name' => 'Roger Federer',
-      },
-      {
-        'id' => 2,
-        'name' => 'Kei Nishikori',
-      }
-    ])
+    expect(users.map(&:attributes)).to match_array(
+      [
+        {
+          "id" => 1,
+          "name" => "Roger Federer"
+        },
+        {
+          "id" => 2,
+          "name" => "Kei Nishikori"
+        }
+      ]
+    )
   end
 
-  it 'creates a Foo::User' do
-    user = Foo::User.new(name: 'Jeremy Lin')
+  it "creates a Foo::User" do
+    user = Foo::User.new(name: "Jeremy Lin")
     user.save
     expect(user.attributes).to eql(
-      'id' => 3,
-      'name' => 'Jeremy Lin',
+      "id" => 3,
+      "name" => "Jeremy Lin"
     )
   end
 
-  it 'updates a Foo::User' do
+  it "updates a Foo::User" do
     user = Foo::User.find(1)
-    user.name = 'Fed GOAT'
+    user.name = "Fed GOAT"
     user.save
     expect(user.attributes).to eql(
-      'id' => 1,
-      'name' => 'Fed GOAT',
+      "id" => 1,
+      "name" => "Fed GOAT"
     )
   end
 
-  it 'destroys a Foo::User' do
+  it "destroys a Foo::User" do
     user = Foo::User.find(1)
     expect(user.destroy).to be_destroyed
   end
 
-  context 'undefined methods' do
-    it 'removes methods that are not compatible with json api' do
+  context "undefined methods" do
+    it "removes methods that are not compatible with json api" do
       [:parse_root_in_json, :include_root_in_json, :root_element, :primary_key].each do |method|
         expect { Foo::User.new.send(method, :foo) }.to raise_error NoMethodError, "Her::JsonApi::Model does not support the #{method} configuration option"
       end

data/spec/middleware/accept_json_spec.rb

@@ -4,7 +4,7 @@ require "spec_helper"
 describe Her::Middleware::AcceptJSON do
   it "adds an Accept header" do
     described_class.new.add_header({}).tap do |headers|
-      headers["Accept"].should == "application/json"
+      expect(headers["Accept"]).to eq("application/json")
     end
   end
 end

data/spec/middleware/first_level_parse_json_spec.rb

@@ -7,55 +7,55 @@ describe Her::Middleware::FirstLevelParseJSON do
   let(:body_with_errors) { "{\"id\": 1, \"name\": \"Tobias Fünke\", \"errors\": { \"name\": [ \"not_valid\", \"should_be_present\" ] }, \"metadata\": 3}" }
   let(:body_with_malformed_json) { "wut." }
   let(:body_with_invalid_json) { "true" }
-  let(:empty_body) { '' }
+  let(:empty_body) { "" }
   let(:nil_body) { nil }
 
   it "parses body as json" do
     subject.parse(body_without_errors).tap do |json|
-      json[:data].should == { :id => 1, :name => "Tobias Fünke" }
-      json[:metadata].should == 3
+      expect(json[:data]).to eq(id: 1, name: "Tobias Fünke")
+      expect(json[:metadata]).to eq(3)
     end
   end
 
   it "parses :body key as json in the env hash" do
-    env = { :body => body_without_errors }
+    env = { body: body_without_errors }
     subject.on_complete(env)
     env[:body].tap do |json|
-      json[:data].should == { :id => 1, :name => "Tobias Fünke" }
-      json[:metadata].should == 3
+      expect(json[:data]).to eq(id: 1, name: "Tobias Fünke")
+      expect(json[:metadata]).to eq(3)
     end
   end
 
-  it 'ensures the errors are a hash if there are no errors' do
-    subject.parse(body_without_errors)[:errors].should eq({})
+  it "ensures the errors are a hash if there are no errors" do
+    expect(subject.parse(body_without_errors)[:errors]).to eq({})
   end
 
-  it 'ensures the errors are a hash if there are no errors' do
-    subject.parse(body_with_errors)[:errors].should eq({:name => [ 'not_valid', 'should_be_present']})
+  it "ensures the errors are a hash if there are no errors" do
+    expect(subject.parse(body_with_errors)[:errors]).to eq(name: %w(not_valid should_be_present))
   end
 
-  it 'ensures that malformed JSON throws an exception' do
+  it "ensures that malformed JSON throws an exception" do
     expect { subject.parse(body_with_malformed_json) }.to raise_error(Her::Errors::ParseError, 'Response from the API must behave like a Hash or an Array (last JSON response was "wut.")')
   end
 
-  it 'ensures that invalid JSON throws an exception' do
+  it "ensures that invalid JSON throws an exception" do
     expect { subject.parse(body_with_invalid_json) }.to raise_error(Her::Errors::ParseError, 'Response from the API must behave like a Hash or an Array (last JSON response was "true")')
   end
 
-  it 'ensures that a nil response returns an empty hash' do
-    subject.parse(nil_body)[:data].should eq({})
+  it "ensures that a nil response returns an empty hash" do
+    expect(subject.parse(nil_body)[:data]).to eq({})
   end
 
-  it 'ensures that an empty response returns an empty hash' do
-    subject.parse(empty_body)[:data].should eq({})
+  it "ensures that an empty response returns an empty hash" do
+    expect(subject.parse(empty_body)[:data]).to eq({})
   end
 
-  context 'with status code 204' do
-    it 'returns an empty body' do
-      env = { :status => 204 }
+  context "with status code 204" do
+    it "returns an empty body" do
+      env = { status: 204 }
       subject.on_complete(env)
       env[:body].tap do |json|
-        json[:data].should == { }
+        expect(json[:data]).to eq({})
       end
     end
   end

data/spec/middleware/json_api_parser_spec.rb

@@ -12,21 +12,20 @@ describe Her::Middleware::JsonApiParser do
       subject.on_complete(env)
       env.fetch(:body).tap do |json|
         expect(json[:data]).to eql(
-          :type => "foo",
-          :id => "bar",
-          :attributes => { :baz => "qux" } 
+          type: "foo",
+          id: "bar",
+          attributes: { baz: "qux" }
         )
         expect(json[:errors]).to eql([])
-        expect(json[:metadata]).to eql(:api => "json api")
+        expect(json[:metadata]).to eql(api: "json api")
       end
     end
   end
 
-  #context "with invalid JSON body" do
+  # context "with invalid JSON body" do
   #  let(:body) { '"foo"' }
   #  it 'ensures that invalid JSON throws an exception' do
   #    expect { subject.parse(body) }.to raise_error(Her::Errors::ParseError, 'Response from the API must behave like a Hash or an Array (last JSON response was "\"foo\"")')
   #  end
-  #end
-
+  # end
 end