her 0.3.6 → 0.3.7

data/TESTING.md

@@ -0,0 +1,88 @@
+# Testing Her models
+
+Suppose we have these two models bound to your API:
+
+```ruby
+# app/models/user.rb
+class User
+  include Her::Model
+  custom_get :popular
+end
+
+# app/models/post.rb
+class Post
+  include Her::Model
+  custom_get :recent, :archived
+end
+```
+
+In order to test them, we’ll have to stub the remote API requests. With [RSpec](https://github.com/rspec/rspec-core), we can do this like so:
+
+```ruby
+# spec/spec_helper.rb
+RSpec.configure do |config|
+  config.include(Module.new do
+    def stub_api_for(klass)
+      klass.uses_api (api = Her::API.new)
+
+      # Here, you would customize this for your own API (URL, middleware, etc)
+      # like you have done in your application’s initializer
+      api.setup :url => "http://api.example.com" do |connection|
+        connection.use Her::Middleware::FirstLevelParseJSON
+        connection.use Faraday::Request::UrlEncoded
+        connection.adapter(:test) { |s| yield(s) }
+      end
+    end
+  end)
+end
+```
+
+Then, in your tests, we can specify what (fake) HTTP requests will return:
+
+```ruby
+# spec/models/user.rb
+describe User do
+  before do
+    stub_api_for(User) do |stub|
+      stub.get("/users/popular") { |env| [200, {}, [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }].to_json] }
+    end
+  end
+
+  describe :popular do
+    subject { User.popular }
+    its(:length) { should == 2 }
+    its(:errors) { should be_empty }
+  end
+end
+```
+
+We can redefine the API for a model as many times as we want, like for more complex tests:
+
+```ruby
+# spec/models/user.rb
+describe Post do
+  describe :recent do
+    before do
+      stub_api_for(Post) do |stub|
+        stub.get("/posts/recent") { |env| [200, {}, [{ :id => 1 }, { :id => 2 }].to_json] }
+      end
+    end
+
+    subject { Post.recent }
+    its(:length) { should == 2 }
+    its(:errors) { should be_empty }
+  end
+
+  describe :archived do
+    before do
+      stub_api_for(Post) do |stub|
+        stub.get("/posts/archived") { |env| [200, {}, [{ :id => 1 }, { :id => 2 }].to_json] }
+      end
+    end
+
+    subject { Post.archived }
+    its(:length) { should == 2 }
+    its(:errors) { should be_empty }
+  end
+end
+```

data/her.gemspec

@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rake", "~> 0.9.2"
+  s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 2.11"
   s.add_development_dependency "yard", "~> 0.8"
   s.add_development_dependency "redcarpet", "~> 2.1"
   s.add_development_dependency "mocha", "~> 0.12"
   s.add_development_dependency "guard", "~> 1.2"
-  s.add_development_dependency "guard-rspec", "~> 1.2"
+  s.add_development_dependency "guard-rspec", "~> 2.3"
   s.add_development_dependency "rb-fsevent", "~> 0.9"
   s.add_development_dependency "growl", "~> 1.0"
 

data/lib/her/api.rb

@@ -39,7 +39,7 @@ module Her
     #   class MyCustomParser < Faraday::Response::Middleware
     #     def on_complete(env)
     #       json = JSON.parse(env[:body], :symbolize_names => true)
-    #       errors = json.delete(:errors) || []
+    #       errors = json.delete(:errors) || {}
     #       metadata = json.delete(:metadata) || []
     #       env[:body] = { :data => json, :errors => errors, :metadata => metadata }
     #     end
@@ -59,7 +59,7 @@ module Her
     end
 
     # Define a custom parsing procedure. The procedure is passed the response object and is
-    # expected to return a hash with three keys: a main data Hash, an errors Array
+    # expected to return a hash with three keys: a main data Hash, an errors Hash
     # and a metadata Hash.
     #
     # @private

data/lib/her/collection.rb

@@ -3,10 +3,10 @@ module Her
     attr_reader :metadata, :errors
 
     # @private
-    def initialize(items=[], metadata={}, errors=[])
+    def initialize(items=[], metadata={}, errors={})
       super(items)
-      @metadata = metadata || {}
-      @errors = errors || []
+      @metadata = metadata
+      @errors = errors
     end
   end
 end

data/lib/her/middleware/first_level_parse_json.rb

@@ -8,7 +8,7 @@ module Her
       # @return [Mixed] the parsed response
       def parse(body)
         json = MultiJson.load(body, :symbolize_keys => true)
-        errors = json.delete(:errors) || []
+        errors = json.delete(:errors) || {}
         metadata = json.delete(:metadata) || []
         {
           :data => json,

data/lib/her/model/http.rb

@@ -5,7 +5,11 @@ module Her
       # Automatically inherit a superclass' api
       def her_api
         @her_api ||= begin
-          superclass.her_api if superclass.respond_to?(:her_api)
+          if superclass.respond_to?(:her_api)
+            superclass.her_api
+          else
+            Her::API.default_api
+          end
         end
       end
 

data/lib/her/model/orm.rb

@@ -4,6 +4,8 @@ module Her
     module ORM
       extend ActiveSupport::Concern
       attr_accessor :data, :metadata, :errors
+      alias :attributes :data
+      alias :attributes= :data=
 
       # Initialize a new object with data received from an HTTP request
       def initialize(params={})
@@ -35,6 +37,9 @@ module Her
           if setter_method_names.include?(setter_method)
             model.send(setter_method, value)
           else
+            if key.is_a?(String)
+              key = key.to_sym
+            end
             memo[key] = value
           end
           memo
@@ -60,6 +65,13 @@ module Her
         method.to_s.end_with?('=') || method.to_s.end_with?('?') || @data.include?(method) || super
       end
 
+      # Assign new data to an instance
+      def assign_data(new_data)
+        new_data = Her::Model::ORM.use_setter_methods(self, new_data)
+        @data.update new_data
+      end
+      alias :assign_attributes :assign_data
+
       # Handles returning true for the accessible attributes
       def has_data?(attribute_name)
         @data.include?(attribute_name)

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

data/spec/collection_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Her::Collection do
+
+  let(:items) { [1,2,3,4] }
+  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({})}
+    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']})}
+    end
+  end
+end

data/spec/middleware/first_level_parse_json_spec.rb

@@ -3,23 +3,30 @@ require "spec_helper"
 
 describe Her::Middleware::FirstLevelParseJSON do
   subject { described_class.new }
-  let(:body) { "{\"id\": 1, \"name\": \"Tobias Fünke\", \"errors\": 2, \"metadata\": 3}" }
+  let(:body_without_errors) { "{\"id\": 1, \"name\": \"Tobias Fünke\", \"metadata\": 3}" }
+  let(:body_with_errors) { "{\"id\": 1, \"name\": \"Tobias Fünke\", \"errors\": { \"name\": [ \"not_valid\", \"should_be_present\" ] }, \"metadata\": 3}" }
 
   it "parses body as json" do
-    subject.parse(body).tap do |json|
+    subject.parse(body_without_errors).tap do |json|
       json[:data].should == { :id => 1, :name => "Tobias Fünke" }
-      json[:errors].should == 2
       json[:metadata].should == 3
     end
   end
 
   it "parses :body key as json in the env hash" do
-    env = { :body => body }
+    env = { :body => body_without_errors }
     subject.on_complete(env)
     env[:body].tap do |json|
       json[:data].should == { :id => 1, :name => "Tobias Fünke" }
-      json[:errors].should == 2
       json[:metadata].should == 3
     end
   end
+
+  it 'ensures the errors are a hash if there are no errors' do
+    subject.parse(body_without_errors)[:errors].should 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']})
+  end
 end

data/spec/model/orm_spec.rb

@@ -49,6 +49,11 @@ describe Her::Model::ORM do
       @existing_user.new?.should be_false
     end
 
+    it "accepts new resource with strings as hash keys" do
+      @new_user = Foo::User.new('fullname' => "Tobias Fünke")
+      @new_user.fullname.should == "Tobias Fünke"
+    end
+
     it "handles method missing for getter" do
       @new_user = Foo::User.new(:fullname => 'Mayonegg')
       lambda { @new_user.unknown_method_for_a_user }.should raise_error(NoMethodError)
@@ -314,6 +319,26 @@ describe Her::Model::ORM do
     end
   end
 
+  context "assigning new resource data" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :active => true }.to_json] }
+        end
+      end
+
+      spawn_model "Foo::User"
+      @user = Foo::User.find(1)
+    end
+
+    it "handles data update through #assign_attributes" do
+      @user.assign_attributes :active => true
+      @user.should be_active
+    end
+  end
+
   context "deleting resources" do
     before do
       Her::API.setup :url => "https://api.example.com" do |builder|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00.000000000 Z
+date: 2012-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
@@ -213,11 +213,15 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CONTRIBUTING.md
+- FEATURES.md
 - Gemfile
 - Guardfile
 - LICENSE
+- MIDDLEWARE.md
 - README.md
 - Rakefile
+- TESTING.md
 - UPGRADE.md
 - examples/twitter-oauth/Gemfile
 - examples/twitter-oauth/app.rb
@@ -246,6 +250,7 @@ files:
 - lib/her/model/relationships.rb
 - lib/her/version.rb
 - spec/api_spec.rb
+- spec/collection_spec.rb
 - spec/middleware/accept_json_spec.rb
 - spec/middleware/first_level_parse_json_spec.rb
 - spec/middleware/second_level_parse_json_spec.rb
@@ -272,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1080420939636029022
+      hash: -1556423297690229107
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -281,16 +286,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1080420939636029022
+      hash: -1556423297690229107
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple Representational State Transfer-based Hypertext Transfer Protocol-powered
   Object Relational Mapper. Her?
 test_files:
 - spec/api_spec.rb
+- spec/collection_spec.rb
 - spec/middleware/accept_json_spec.rb
 - spec/middleware/first_level_parse_json_spec.rb
 - spec/middleware/second_level_parse_json_spec.rb