restfolia 1.0.0 → 1.0.1

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+ENV["RUBYOPT"] = "rubygems" if ENV["RUBYOPT"].nil?
+
 Rake::TestTask.new do |t|
   t.libs.push "lib"
   t.libs.push "test"

data/Readme.md

@@ -1,5 +1,7 @@
+![Logo Restfolia][logo_readme]
 # Restfolia [![Build Status][travis_status]][travis]
 
+[logo_readme]: http://rogerleite.github.com/restfolia/images/logo_readme.png
 [travis_status]: https://secure.travis-ci.org/rogerleite/restfolia.png
 [travis]: http://travis-ci.org/rogerleite/restfolia
 

data/lib/restfolia/http/behaviour.rb

@@ -55,13 +55,13 @@ module Restfolia::HTTP
 
       # Public: Creates a Store.
       def initialize
-        self.clear
+        self.clear!
         @helpers = Helpers.new
       end
 
       # Public: clear all defined behaviours.
       # Returns nothing.
-      def clear
+      def clear!
         @behaviours = {}
         @behaviours_range = {}
         nil

data/lib/restfolia/resource_creator.rb

@@ -34,23 +34,6 @@ module Restfolia
   #
   class ResourceCreator
 
-    # Public: By default, returns Restfolia::Resource. You can use
-    # this method to override and returns a custom Resource. See examples.
-    #
-    # Examples
-    #
-    #   # using a custom Resource
-    #   class Restfolia::ResourceCreator
-    #     def resource_class
-    #       OpenStruct  #dont forget to require 'ostruct'
-    #     end
-    #   end
-    #
-    # Returns class of Resource to be constructed.
-    def resource_class
-      Restfolia::Resource
-    end
-
     # Public: creates Resource looking recursively for JSON
     # objects and transforming in Resources. To create Resource,
     # this method use #resource_class.new(json).
@@ -66,25 +49,63 @@ module Restfolia
 
       json_parsed = {}
       json.each do |attr, value|
-        json_parsed[attr] = look_for_resource(value)
+        json_parsed[attr] = look_for_resource(attr, value)
       end
       resource_class.new(json_parsed)
     end
 
     protected
 
+    # Internal: By default, returns Restfolia::Resource. You can use
+    # this method to override and returns a custom Resource.
+    #
+    # Examples
+    #
+    #   # using a custom Resource
+    #   class Restfolia::ResourceCreator
+    #     def resource_class
+    #       OpenStruct  #dont forget to require 'ostruct'
+    #     end
+    #   end
+    #
+    # Returns class of Resource to be constructed.
+    def resource_class
+      Restfolia::Resource
+    end
+
+    # Internal: By default, returns :links or :link. You can use
+    # this method to override and returns a custom rule, can be an
+    # Array or any object that responds to include?.
+    #
+    # Examples
+    #
+    #   class Restfolia::ResourceCreator
+    #     def attributes_to_dont_parse
+    #       [:links, :link, :_links].freeze
+    #     end
+    #   end
+    #
+    # Returns attributes to be ignored when creating Resource.
+    def attributes_to_dont_parse
+      [:links, :link].freeze
+    end
+
     # Internal: Check if value is eligible to become a Restfolia::Resource.
+    # It attr_name exist in #attributes_to_dont_parse, it returns value.
     # If value is Array object, looks inner contents, using rules below.
     # If value is Hash object, it becomes a Restfolia::Resource.
     # Else return itself.
     #
+    # attr_name  - attribute name from parsed hash.
     # value - object to be checked.
     #
     # Returns value itself or Resource.
-    def look_for_resource(value)
+    def look_for_resource(attr_name, value)
+      return value if attributes_to_dont_parse.include?(attr_name)
+
       if value.is_a?(Array)
         value = value.inject([]) do |resources, array_obj|
-          resources << look_for_resource(array_obj)
+          resources << look_for_resource(attr_name, array_obj)
         end
       elsif value.is_a?(Hash)
         value = resource_class.new(value)

data/lib/restfolia/version.rb

@@ -1,3 +1,3 @@
 module Restfolia
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/restfolia.rb

@@ -1,7 +1,6 @@
 require "net/http"
 require "uri"
 
-require "rubygems"
 require "multi_json"
 
 require "restfolia/version"

data/restfolia.gemspec

@@ -5,7 +5,7 @@ require "restfolia/version"
 Gem::Specification.new do |s|
   s.name        = "restfolia"
   s.version     = Restfolia::VERSION
-  s.authors     = `git log --raw | grep Author: | awk -F ': | <|>' '{ print $2 }' | sort | uniq`.split("\n")
+  s.authors     = ["Roger Leite"]
   s.email       = ["roger.barreto@gmail.com"]
   s.homepage    = "http://rogerleite.github.com/restfolia"
   s.summary     = %q{REST client to consume and interact with Hypermedia API}
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "multi_json", "~> 1.3.0"
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "minitest-reporters"
-  s.add_development_dependency "webmock"
+  s.add_development_dependency "minitest", "~> 3"
+  s.add_development_dependency "minitest-reporters", "~> 0.7.0"
+  s.add_development_dependency "webmock", "~> 1"
 end

data/samples/changing_links_parse.rb

@@ -1,8 +1,7 @@
 
 # Run this sample from root project:
-# $ ruby samples/changing_links_parse.rb
+# $ ruby -rubygems samples/changing_links_parse.rb
 
-require "rubygems"
 $LOAD_PATH << "lib"
 require "restfolia"
 

data/samples/cookies_options.rb

@@ -1,11 +1,11 @@
 
 # Run this sample from root project:
-# $ ruby samples/cookies_options.rb
+# $ ruby -rubygems samples/cookies_options.rb
 
-require "rubygems"
 $LOAD_PATH << "lib"
 require "restfolia"
 
+# Running https://github.com/rogerleite/simple_api
 SERVICE_URL = "http://localhost:9292/recursos/busca"
 
 sample_cookie = "PREF=ID=988f14fa5edd3243:TM=1335470032:LM=1335470032:S=KVBslNbyz6bG0DqU; expires=Sat, 26-Apr-2014 19:53:52 GMT; path=/; domain=.google.com, NID=59=peUyZQuLWQ_0gELr1yDf0FT4ZlT7ZdITNrO5OhkEnAvp_8MZ4TT6pHq7_q_Su-puTw7vGml_Ok6du8fLreGHzfpMs4Qh1v-qBCFYGuCNbzpwN670x5MFbGKy0KUXA3WP; expires=Fri, 26-Oct-2012 19:53:52 GMT; path=/; domain=.google.com; HttpOnly"

data/samples/headers_options.rb

@@ -1,11 +1,11 @@
 
 # Run this sample from root project:
-# $ ruby samples/headers_options.rb
+# $ ruby -rubygems samples/headers_options.rb
 
-require "rubygems"
 $LOAD_PATH << "lib"
 require "restfolia"
 
+# Running https://github.com/rogerleite/simple_api
 SERVICE_URL = "http://localhost:9292/recursos/busca"
 
 # accessing headers attribute

data/samples/http_behaviour.rb

@@ -1,14 +1,14 @@
 
 # Run this sample from root project:
-# $ ruby samples/http_behaviour.rb
+# $ ruby -rubygems samples/http_behaviour.rb
 
-require "rubygems"
 $LOAD_PATH << "lib"
 require "restfolia"
-require "ostruct"
 
 Restfolia::HTTP.behaviours do
 
+  clear!  #clear all defined behaviours
+
   on(200) do |http_response|
     content_type = (http_response["content-type"] =~ /application\/json/)
     if !content_type
@@ -36,17 +36,13 @@ Restfolia::HTTP.behaviours do
   #  custom_helper
   #end
 
-  #helpers do
-  #  def custom_helper
-  #    'lixo'
-  #  end
-  #end
-
 end
 
+# Running https://github.com/rogerleite/simple_api
 SERVICE_URL = "http://localhost:9292/recursos/busca"
+
 resource = Restfolia.at(SERVICE_URL).get
-puts resource.inspect
+puts resource.inspect  # => #<Restfolia::Resource ...>
 
 Restfolia.at("http://google.com").get
 # => "3xx error"

data/samples/n0tice_api.rb

@@ -0,0 +1,31 @@
+# This is a small sample to show how to consume search from http://n0tice.org API.
+# Reference: http://n0tice.org/developers/
+#
+# Run this sample from root project:
+# $ ruby -rubygems samples/n0tice_api.rb
+
+$LOAD_PATH << "lib"
+require "restfolia"
+
+class Restfolia::Resource
+
+  # Return "self" link, if "apiUrl" exists.
+  def parse_links(json)
+    self_url = json[:apiUrl]
+    return [] if self_url.nil?
+
+    [Restfolia::EntryPoint.new(self_url, "self")]
+  end
+
+end
+
+result = Restfolia.at("http://n0ticeapis.com/2/search?type=report&location=Brazil").get
+
+puts result.place.name  # => "Brazil"
+
+first_report = result.results.first
+puts first_report.headline  # => "Camp Nectar ..."
+
+# Request report info. Ex: http://n0ticeapis.com/2/report/4220
+report = first_report.links("self").get
+puts report.webUrl  # => "http://..."

data/samples/using_custom_factory.rb

@@ -1,16 +1,16 @@
 
 # Run this sample from root project:
-# $ ruby samples/using_custom_factory.rb
+# $ ruby -rubygems samples/using_custom_factory.rb
 
-require "rubygems"
 $LOAD_PATH << "lib"
 require "restfolia"
 require "ostruct"
 
+# Running https://github.com/rogerleite/simple_api
 SERVICE_URL = "http://localhost:9292/recursos/busca"
 
 resource = Restfolia.at(SERVICE_URL).get
-puts resource.inspect # => #<Restfolia::Resource ...>
+#puts resource.inspect # => #<Restfolia::Resource ...>
 
 # Here you have the "pure" json from response body.
 # You can do anything.

data/samples/using_custom_resource.rb

@@ -1,16 +1,16 @@
 
 # Run this sample from root project:
-# $ ruby samples/using_custom_resource.rb
+# $ ruby -rubygems samples/using_custom_resource.rb
 
-require "rubygems"
 $LOAD_PATH << "lib"
 require "restfolia"
 require "ostruct"
 
+# Running https://github.com/rogerleite/simple_api
 SERVICE_URL = "http://localhost:9292/recursos/busca"
 
 resource = Restfolia.at(SERVICE_URL).get
-puts resource.inspect # => #<Restfolia::Resource ...>
+#puts resource.inspect # => #<Restfolia::Resource ...>
 
 # Here you have the advantage to use a custom resource
 # and the same time you have the recursive lookup at hash

data/test/restfolia/http_behaviour_test.rb

@@ -35,8 +35,10 @@ describe Restfolia::HTTP::Behaviour do
       end
 
       it "should call #default_behaviour for non match code" do
-        @http_mock.expect(:code, "666")
-        lambda { subject.execute(@http_mock) }.
+        http_mock = Object.new
+        http_mock.instance_eval { def code; "666"; end }
+
+        lambda { subject.execute(http_mock) }.
           must_raise(Restfolia::ResponseError)
       end
     end

data/test/restfolia/resource_creator_test.rb

@@ -28,6 +28,16 @@ describe Restfolia::ResourceCreator do
       resource.attr_test.nested.must_equal("nested")
     end
 
+    it "should not parse if attribute is on attributes_to_dont_parse" do
+      def subject.attributes_to_dont_parse
+        [:to_ignore]
+      end
+      resource = subject.create(:attr_test => {:nested => "nested"},
+                                :to_ignore => {:rel => "test"})
+      resource.must_be_instance_of(OpenStruct)
+      resource.to_ignore.must_be_instance_of(Hash)
+    end
+
     it "transforms nested hash from Arrays in Resource" do
       resource = subject.create(:attr_test => [{:nested_array => "object"}],
                                 :attr_test2 => ["not object"])

metadata

@@ -1,23 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: restfolia
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
-- Nadilson
 - Roger Leite
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-05-16 00:00:00 -03:00
-default_executable: 
+date: 2012-05-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json
@@ -55,12 +53,12 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
-        - 0
-        version: "0"
+        - 3
+        version: "3"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -69,12 +67,14 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
         - 0
-        version: "0"
+        - 7
+        - 0
+        version: 0.7.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -83,12 +83,12 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1
         segments: 
-        - 0
-        version: "0"
+        - 1
+        version: "1"
   type: :development
   version_requirements: *id005
 description: REST client to consume and interact with Hypermedia API
@@ -120,11 +120,11 @@ files:
 - lib/restfolia/resource_creator.rb
 - lib/restfolia/version.rb
 - restfolia.gemspec
-- samples/changing_behaviour.rb
 - samples/changing_links_parse.rb
 - samples/cookies_options.rb
 - samples/headers_options.rb
 - samples/http_behaviour.rb
+- samples/n0tice_api.rb
 - samples/using_custom_factory.rb
 - samples/using_custom_resource.rb
 - test/restfolia/entry_point_test.rb
@@ -136,7 +136,6 @@ files:
 - test/support/json_samples.rb
 - test/support/stub_helpers.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://rogerleite.github.com/restfolia
 licenses: 
 - MIT
@@ -166,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: restfolia
-rubygems_version: 1.4.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: REST client to consume and interact with Hypermedia API

data/samples/changing_behaviour.rb

@@ -1,32 +0,0 @@
-
-# Run this sample from root project:
-# $ ruby samples/changing_behaviour.rb
-
-require "rubygems"
-$LOAD_PATH << "lib"
-require "restfolia"
-
-begin
-  # Default behaviour to redirect 3xx is raise Error
-  Restfolia.at("http://google.com.br").get
-rescue Restfolia::ResponseError => ex
-  puts ex.message
-end
-
-module Restfolia::HTTP::Behaviour
-
-  # We can change behaviour of many HTTP status
-  # on_2xx(http_response)
-  # on_3xx(http_response)
-  # on_4xx(http_response)
-  # on_5xx(http_response)
-
-  # Here we change 3xx behaviour to return a Resource
-  def on_3xx(http_response)
-    Restfolia.create_resource(:redirected => "I'm free! :D")
-  end
-
-end
-
-resource = Restfolia.at("http://google.com.br").get
-puts resource.redirected