her 0.2.4 → 0.2.5

data/README.md

@@ -179,22 +179,19 @@ gem "faraday_middleware"
 In your Ruby code:
 
 ```ruby
-class MyCache
-  def initialize
-    @cache = {}
-  end
-
-  def write(key, value)
-    @cache[key] = value
+class MyCache < Hash
+  def read(key)
+    if cached = self[key]
+      Marshal.load(cached)
+    end
   end
 
-  def read(key)
-    @cache[key]
+  def write(key, data)
+    self[key] = Marshal.dump(data)
   end
 
-  def fetch(key, &block)
-    return value = read(key) if value.nil?
-    write key, yield
+  def fetch(key)
+    read(key) || yield.tap { |data| write(key, data) }
   end
 end
 
@@ -445,9 +442,22 @@ Category.all
 * Better error handling
 * Better API documentation (using YARD)
 
-## Contributors
+## Contribute
 
-Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/her/issues) like these fine folks did:
+Yes please! Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/her/issues).
+
+### How to contribute
+
+* Fork the repository
+* Implement your feature or fix
+* Add examples that describe it (in the `spec` directory)
+* Make sure `bundle exec rake spec` passes after your modifications
+* Commit (bonus points for doing it in a `feature-*` branch)
+* Send a pull request!
+
+### Contributors
+
+These fine folks helped with Her:
 
 * [@jfcixmedia](https://github.com/jfcixmedia)
 * [@EtienneLem](https://github.com/EtienneLem)
@@ -455,8 +465,6 @@ Feel free to contribute and submit issues/pull requests [on GitHub](https://gith
 * [@tysontate](https://github.com/tysontate)
 * [@nfo](https://github.com/nfo)
 
-Take a look at the `spec` folder before you do, and make sure `bundle exec rake spec` passes after your modifications :)
-
 ## License
 
 Her is © 2012 [Rémi Prévost](http://exomel.com) and may be freely distributed under the [MIT license](https://github.com/remiprev/her/blob/master/LICENSE). See the `LICENSE` file.

data/UPGRADE.md

@@ -4,27 +4,27 @@ Here is a list of backward-incompatible changes that were introduced while Her i
 
 * Her no longer includes default middleware when making HTTP requests. The user has now to define all the needed middleware. Before:
 
-      Her::API.setup :base_uri => "https://api.example.com" do |builder|
-        builder.insert(0, FaradayMiddle::OAuth)
-      end
+        Her::API.setup :base_uri => "https://api.example.com" do |builder|
+          builder.insert(0, FaradayMiddle::OAuth)
+        end
 
   Now:
     
-      Her::API.setup :base_uri => "https://api.example.com" do |builder|
-        builder.use FaradayMiddle::OAuth
-        builder.use Her::Middleware::FirstLevelParseJSON
-        builder.use Faraday::Request::UrlEncoded
-        builder.use Faraday::Adapter::NetHttp
-      end
+        Her::API.setup :base_uri => "https://api.example.com" do |builder|
+          builder.use FaradayMiddle::OAuth
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Adapter::NetHttp
+        end
 
 ## 0.2
 
 * The default parser middleware has been replaced to treat first-level JSON data as the resource or collection data. Before it expected this:
 
-      { "data": { "id": 1, "name": "Foo" }, "errors": [] }
+        { "data": { "id": 1, "name": "Foo" }, "errors": [] }
         
    Now it expects this (the `errors` key is not treated as resource data):
    
-      { "id": 1, "name": "Foo", "errors": [] }
+        { "id": 1, "name": "Foo", "errors": [] }
       
    If you still want to get the old behavior, you can use `Her::Middleware::SecondLevelParseJSON` instead of `Her::Middleware::FirstLevelParseJSON` in your middleware stack.

data/examples/twitter-search/app.rb

@@ -12,22 +12,19 @@ class TwitterSearchParser < Faraday::Response::Middleware
   end
 end
 
-class MyCache
-  def initialize
-    @cache = {}
-  end
-
-  def write(key, value)
-    @cache[key] = value
+class MyCache < Hash
+  def read(key)
+    if cached = self[key]
+      Marshal.load(cached)
+    end
   end
 
-  def read(key)
-    @cache[key]
+  def write(key, data)
+    self[key] = Marshal.dump(data)
   end
 
-  def fetch(key, &block)
-    return value = read(key) if value.nil?
-    write key, yield
+  def fetch(key)
+    read(key) || yield.tap { |data| write(key, data) }
   end
 end
 
@@ -35,8 +32,10 @@ $cache = MyCache.new
 
 # Initialize API
 Her::API.setup :base_uri => "http://search.twitter.com" do |builder|
-  builder.swap Her::Middleware::FirstLevelParseJSON, TwitterSearchParser
+  builder.use Faraday::Request::UrlEncoded
   builder.use FaradayMiddleware::Caching, $cache
+  builder.use TwitterSearchParser
+  builder.use Faraday::Adapter::NetHttp
 end
 
 # Define classes
@@ -49,6 +48,6 @@ class Tweet
 end
 
 get "/" do
-  @tweets = Tweet.search("github", :rpp => 30)
+  @tweets = Tweet.search("justin bieber", :rpp => 30)
   haml :index
 end

data/lib/her/model/http.rb

@@ -26,7 +26,7 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data)
+            new_collection(parsed_data[:data])
           else
             new(parsed_data[:data])
           end
@@ -43,7 +43,7 @@ module Her
       def get_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data)
+          new_collection(parsed_data[:data])
         end
       end # }}}
 
@@ -60,7 +60,7 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data)
+            new_collection(parsed_data[:data])
           else
             new(parsed_data[:data])
           end
@@ -77,7 +77,7 @@ module Her
       def post_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data)
+          new_collection(parsed_data[:data])
         end
       end # }}}
 
@@ -94,7 +94,7 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data)
+            new_collection(parsed_data[:data])
           else
             new(parsed_data[:data])
           end
@@ -111,7 +111,7 @@ module Her
       def put_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data)
+          new_collection(parsed_data[:data])
         end
       end # }}}
 
@@ -128,7 +128,7 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data)
+            new_collection(parsed_data[:data])
           else
             new(parsed_data[:data])
           end
@@ -145,7 +145,7 @@ module Her
       def patch_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data)
+          new_collection(parsed_data[:data])
         end
       end # }}}
 
@@ -162,7 +162,7 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data)
+            new_collection(parsed_data[:data])
           else
             new(parsed_data[:data])
           end
@@ -179,7 +179,7 @@ module Her
       def delete_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data)
+          new_collection(parsed_data[:data])
         end
       end # }}}
 

data/lib/her/model/orm.rb

@@ -39,9 +39,8 @@ module Her
 
       # Initialize a collection of resources with raw data from an HTTP request
       #
-      # @param [Hash] parsed_data The raw `parsed_data` parsed from the HTTP response
-      def new_collection(parsed_data) # {{{
-        collection_data = parsed_data[:data]
+      # @param [Array] collection_data An array of model hashes
+      def new_collection(collection_data) # {{{
         Her::Model::ORM.initialize_collection(self.to_s.underscore, collection_data)
       end # }}}
 
@@ -68,7 +67,7 @@ module Her
       #   # Fetched via GET "/users"
       def all(params={}) # {{{
         request(params.merge(:_method => :get, :_path => "#{build_request_path(params)}")) do |parsed_data|
-          new_collection(parsed_data)
+          new_collection(parsed_data[:data])
         end
       end # }}}
 

data/lib/her/model/relationships.rb

@@ -16,11 +16,11 @@ module Her
           relationships.each do |relationship|
             if data.include?(relationship[:name])
               if type == :has_many
-                data[relationship[:name]] = Her::Model::ORM.initialize_collection(relationship[:name], data[relationship[:name]])
+                data[relationship[:name]] = Her::Model::ORM.initialize_collection(relationship[:class_name], data[relationship[:name]])
               elsif type == :has_one
-                data[relationship[:name]] = Object.const_get(relationship[:name].to_s.classify).new(data[relationship[:name]])
+                data[relationship[:name]] = Object.const_get(relationship[:class_name]).new(data[relationship[:name]])
               elsif type == :belongs_to
-                data[relationship[:name]] = Object.const_get(relationship[:name].to_s.classify).new(data[relationship[:name]])
+                data[relationship[:name]] = Object.const_get(relationship[:class_name]).new(data[relationship[:name]])
               end
             end
           end
@@ -48,11 +48,12 @@ module Her
       #   # Fetched via GET "/users/1/articles"
       def has_many(name, attrs={}) # {{{
         @her_relationships ||= {}
-        (@her_relationships[:has_many] ||= []) << attrs.merge(:name => name)
+        attrs = { :class_name => name.to_s.classify, :name => name }.merge(attrs)
+        (@her_relationships[:has_many] ||= []) << attrs
 
         define_method(name) do
           return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          self.class.get_collection("#{self.class.build_request_path(:id => id)}/#{name.to_s.pluralize}")
+          Object.const_get(attrs[:class_name]).get_collection("#{self.class.build_request_path(:id => id)}/#{name.to_s.pluralize}")
         end
       end # }}}
 
@@ -76,11 +77,12 @@ module Her
       #   # Fetched via GET "/users/1/organization"
       def has_one(name, attrs={}) # {{{
         @her_relationships ||= {}
-        (@her_relationships[:has_one] ||= []) << attrs.merge(:name => name)
+        attrs = { :class_name => name.to_s.classify, :name => name, :foreign_key => "#{name}_id" }.merge(attrs)
+        (@her_relationships[:has_one] ||= []) << attrs
 
         define_method(name) do
           return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          self.class.get_resource("#{self.class.build_request_path(:id => id)}/#{name.to_s.singularize}")
+          Object.const_get(attrs[:class_name]).get_resource("#{self.class.build_request_path(:id => id)}/#{name.to_s.singularize}")
         end
       end # }}}
 
@@ -104,11 +106,12 @@ module Her
       #   # Fetched via GET "/teams/2"
       def belongs_to(name, attrs={}) # {{{
         @her_relationships ||= {}
-        (@her_relationships[:belongs_to] ||= []) << attrs.merge(:name => name)
+        attrs = { :class_name => name.to_s.classify, :name => name, :foreign_key => "#{name}_id" }.merge(attrs)
+        (@her_relationships[:belongs_to] ||= []) << attrs
 
         define_method(name) do
           return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          self.class.get_resource("#{Object.const_get(name.to_s.classify).build_request_path(:id => @data["#{name}_id".to_sym])}")
+          Object.const_get(attrs[:class_name]).get_resource("#{Object.const_get(name.to_s.classify).build_request_path(:id => @data["#{name}_id".to_sym])}")
         end
       end # }}}
     end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/model/relationships_spec.rb

@@ -2,46 +2,67 @@
 require File.join(File.dirname(__FILE__), "../spec_helper.rb")
 
 describe Her::Model::Relationships do
-  context "setting relationships" do
+  context "setting relationships without details" do
     before do # {{{
       spawn_model :User
     end # }}}
 
     it "handles a single 'has_many' relationship" do # {{{
       User.has_many :comments
-      User.relationships[:has_many].should == [{ :name => :comments }]
+      User.relationships[:has_many].should == [{ :name => :comments, :class_name => "Comment" }]
     end # }}}
 
     it "handles multiples 'has_many' relationship" do # {{{
       User.has_many :comments
       User.has_many :posts
-      User.relationships[:has_many].should == [{ :name => :comments }, { :name => :posts }]
+      User.relationships[:has_many].should == [{ :name => :comments, :class_name => "Comment" }, { :name => :posts, :class_name => "Post" }]
     end # }}}
 
     it "handles a single 'has_one' relationship" do # {{{
       User.has_one :category
-      User.relationships[:has_one].should == [{ :name => :category }]
+      User.relationships[:has_one].should == [{ :name => :category, :class_name => "Category", :foreign_key => "category_id" }]
     end # }}}
 
     it "handles multiples 'has_one' relationship" do # {{{
       User.has_one :category
       User.has_one :role
-      User.relationships[:has_one].should == [{ :name => :category }, { :name => :role }]
+      User.relationships[:has_one].should == [{ :name => :category, :class_name => "Category", :foreign_key => "category_id" }, { :name => :role, :class_name => "Role", :foreign_key => "role_id" }]
     end # }}}
 
     it "handles a single belongs_to relationship" do # {{{
       User.belongs_to :organization
-      User.relationships[:belongs_to].should == [{ :name => :organization }]
+      User.relationships[:belongs_to].should == [{ :name => :organization, :class_name => "Organization", :foreign_key => "organization_id" }]
     end # }}}
 
     it "handles multiples 'belongs_to' relationship" do # {{{
       User.belongs_to :organization
       User.belongs_to :family
-      User.relationships[:belongs_to].should == [{ :name => :organization }, { :name => :family }]
+      User.relationships[:belongs_to].should == [{ :name => :organization, :class_name => "Organization", :foreign_key => "organization_id" }, { :name => :family, :class_name => "Family", :foreign_key => "family_id" }]
     end # }}}
   end
 
-  context "handling relationships" do
+  context "setting relationships with details" do
+    before do # {{{
+      spawn_model :User
+    end # }}}
+
+    it "handles a single 'has_many' relationship" do # {{{
+      User.has_many :comments, :class_name => "Post"
+      User.relationships[:has_many].should == [{ :name => :comments, :class_name => "Post" }]
+    end # }}}
+
+    it "handles a single 'has_one' relationship" do # {{{
+      User.has_one :category, :class_name => "Topic", :foreign_key => "topic_id"
+      User.relationships[:has_one].should == [{ :name => :category, :class_name => "Topic", :foreign_key => "topic_id" }]
+    end # }}}
+
+    it "handles a single belongs_to relationship" do # {{{
+      User.belongs_to :organization, :class_name => "Business", :foreign_key => "business_id"
+      User.relationships[:belongs_to].should == [{ :name => :organization, :class_name => "Business", :foreign_key => "business_id" }]
+    end # }}}
+  end
+
+  context "handling relationships without details" do
     before do # {{{
       Her::API.setup :base_uri => "https://api.example.com" do |builder|
         builder.use Her::Middleware::FirstLevelParseJSON
@@ -65,39 +86,44 @@ describe Her::Model::Relationships do
       spawn_model :Comment
       spawn_model :Role
 
-
       @user_with_included_data = User.find(1)
       @user_without_included_data = User.find(2)
     end # }}}
 
     it "maps an array of included data through has_many" do # {{{
+      @user_with_included_data.comments.first.class.should == Comment
       @user_with_included_data.comments.length.should == 2
       @user_with_included_data.comments.first.id.should == 2
       @user_with_included_data.comments.first.body.should == "Tobias, you blow hard!"
     end # }}}
 
     it "fetches data that was not included through has_many" do # {{{
+      @user_without_included_data.comments.first.class.should == Comment
       @user_without_included_data.comments.length.should == 2
       @user_without_included_data.comments.first.id.should == 4
       @user_without_included_data.comments.first.body.should == "They're having a FIRESALE?"
     end # }}}
 
     it "maps an array of included data through has_one" do # {{{
+      @user_with_included_data.role.class.should == Role
       @user_with_included_data.role.id.should == 1
       @user_with_included_data.role.body.should == "Admin"
     end # }}}
 
     it "fetches data that was not included through has_one" do # {{{
+      @user_without_included_data.role.class.should == Role
       @user_without_included_data.role.id.should == 2
       @user_without_included_data.role.body.should == "User"
     end # }}}
 
     it "maps an array of included data through belongs_to" do # {{{
+      @user_with_included_data.organization.class.should == Organization
       @user_with_included_data.organization.id.should == 1
       @user_with_included_data.organization.name.should == "Bluth Company"
     end # }}}
 
     it "fetches data that was not included through belongs_to" do # {{{
+      @user_without_included_data.organization.class.should == Organization
       @user_without_included_data.organization.id.should == 1
       @user_without_included_data.organization.name.should == "Bluth Company"
     end # }}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000Z
+date: 2012-05-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -282,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3092731316656290620
+      hash: 112971381959523864
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -291,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3092731316656290620
+      hash: 112971381959523864
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.18