passive_resource 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in passive_resource.gemspec
+gemspec

data/README

@@ -0,0 +1,46 @@
+Use passive resource to create on instances from hashes especially from third party apis.
+Allows for the ability place hash manipulation logic in one neat place
+
+Examples:
+
+used with a hash or hash like object
+> require 'passive_resource'
+=> true 
+> class NewClass < PassiveResource::Base
+> def whole_name; "#{first_name} #{last_name}" end
+>   end
+=> nil 
+> instance = NewClass.new(:first_name => 'grady', :last_name => 'griffin')
+=> {"first_name"=>"grady", "last_name"=>"griffin"} 
+> instance.first_name
+=> "grady"
+> instance.whole_name
+=> "grady griffin"
+
+
+Used as with an api returning json
+
+> class FacebookProfile < PassiveResource::Base
+>  end
+=> nil
+> facebook = FacebookProfile.new('https://graph.facebook.com/19292868552')
+ => {"id"=>"19292868552", "name"=>"Facebook Platform", "picture"=>"http://profile.ak.fbcdn.net/hprofile-ak-ash2/276791_19292868552_1958181823_s.jpg", "link"=>"http://www.facebook.com/platform", "likes"=>3923792, "category"=>"Product/service", "website"=>"http://developers.facebook.com", "username"=>"platform", "founded"=>"2007", "company_overview"=>"Facebook Platform enables anyone to build social apps on Facebook and the web.", "mission"=>"To make the web more open and social.", "about"=>"We're building the social web. Get the latest here: developers.facebook.com ", "talking_about_count"=>74536}
+> facebook.talking_about_count
+=> 74536 
+> facebook.founded
+=> "2007"
+
+Works with code that was previously using hashes
+
+> facebook['talking_about_count']
+ => 74536 
+> facebook[:founded]
+ => "2007"
+ 
+Objects are nested automatically
+> instance = NewClass.new(:locations => [{:city => 'Orlando', :state => "FL"}, {:city => 'Greenwood', :state => "SC"}])
+ => {"locations"=>[{"city"=>"Orlando", "state"=>"FL"}, {"city"=>"Greenwood", "state"=>"SC"}]} 
+> instance.locations
+ => [{"city"=>"Orlando", "state"=>"FL"}, {"city"=>"Greenwood", "state"=>"SC"}] 
+> instance.locations.first.city
+ => "Orlando"

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/passive_resource/base.rb

@@ -0,0 +1,72 @@
+module PassiveResource
+  class Base
+    require 'active_support/core_ext/hash/indifferent_access'
+    require 'active_support/json'
+    require 'rest_client'
+  
+    HASH_METHODS = (ActiveSupport::HashWithIndifferentAccess.new.methods - Object.new.methods)
+  
+    def initialize(p = {})
+      p = load_from_url(p) if p.is_a?(String)
+      if self.class.nestable?(p)
+        @seedling = ActiveSupport::HashWithIndifferentAccess.new(p)
+      elsif self.class.collection?(p)
+        @seedling = self.class.many(p)
+      else
+        raise PassiveResource::InvalidSeedlingException, "A hash like object or a collection of hash like objects is required"
+      end
+    end
+  
+    def seedling
+      @seedling
+    end
+    
+    def respond_to?(method)
+      return true if super
+      accessor = method.to_s.gsub(/\=$/,'')
+      @seedling.has_key?(accessor) or HASH_METHODS.include?(method)
+    end
+  
+    def [](key)
+      if self.class.nestable?(@seedling[key])
+        @seedling[key] = self.class.new(@seedling[key])
+      elsif self.class.collection?(@seedling[key])
+        @seedling[key] = self.class.many(@seedling[key])
+      end
+      @seedling[key]
+    end
+  
+    def self.many(ary)
+      ary = [ary].compact.flatten
+      ary.collect {|hash| nestable?(hash) ? new(hash) : hash }
+    end
+  
+    def method_missing(method_sym, *arguments, &block)
+      accessor = method_sym.to_s.gsub(/\=$/,'')
+      if @seedling.has_key?(accessor)
+        accessor == method_sym.to_s ? self[accessor] : @seedling[accessor] = arguments.first
+      elsif HASH_METHODS.include?(method_sym)
+        @seedling.send(method_sym, *arguments, &block)
+      else
+        super
+      end
+    end
+  
+    def inspect
+      @seedling.inspect
+    end
+    
+    def load_from_url(url)
+      rtn = RestClient.get(url)
+      JSON.parse(rtn)
+    end
+
+    def self.nestable?(obj)
+      ['ActiveSupport::HashWithIndifferentAccess', 'HashWithIndifferentAccess', 'Hash'].include?(obj.class.to_s)
+    end
+  
+    def self.collection?(obj)
+      ['Array', 'WillPaginate::Collection'].include?(obj.class.to_s)
+    end
+  end
+end

data/lib/passive_resource/error.rb

@@ -0,0 +1,3 @@
+module PassiveResource
+  class InvalidSeedlingException < StandardError; end
+end

data/lib/passive_resource/version.rb

@@ -0,0 +1,3 @@
+module PassiveResource
+  VERSION = "0.0.1"
+end

data/lib/passive_resource.rb

@@ -0,0 +1,7 @@
+require "passive_resource/version"
+require "passive_resource/base"
+require "passive_resource/error"
+
+module PassiveResource
+  # Your code goes here...
+end

data/passive_resource.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "passive_resource/version"
+require "passive_resource/base"
+require "passive_resource/error"
+
+Gem::Specification.new do |s|
+  s.name        = "passive_resource"
+  s.version     = PassiveResource::VERSION
+  s.authors     = ["Grady Griffin"]
+  s.email       = ["gradyg@izea.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple objects from json}
+  s.description = %q{Creates Ruby objects from JSON requested from apis or hashes}
+
+  s.rubyforge_project = "passive_resource"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    s.add_dependency("activesupport", '> 2.3')
+    s.add_dependency "rest-client"
+    s.add_dependency "rspec"
+  else
+    s.add_runtime_dependency("activesupport", '> 2.3')
+    s.add_runtime_dependency "rest-client"
+    s.add_development_dependency "rspec"
+  end
+end

data/spec/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+rspec --configure autotest
+

data/spec/base_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+describe PassiveResource::Base, "#new" do
+  it "should return a PassiveResource::Base instance" do
+    instance = PassiveResource::Base.new
+    instance.class.to_s.should eq('PassiveResource::Base')
+  end
+  
+  it "should define methods as specified in the hash" do
+    instance = PassiveResource::Base.new(:name => 'grady')
+    instance.name.should eq('grady')
+  end
+  
+  it "should nest PassiveResource::Base objects" do
+    instance = PassiveResource::Base.new(:location => {:city => 'Orlando'})
+    instance.location.class.to_s.should eq('PassiveResource::Base')
+  end
+  
+  it "should nest PassiveResource::Base objects within collections" do
+    instance = PassiveResource::Base.new(:cities => [{:city => 'Orlando'}, {:city => 'Greenwood'}])
+    instance.cities.all? {|item| item.is_a?(PassiveResource::Base)}.should eq(true)
+  end
+  
+  it "should respond to Hash methods" do
+    instance = PassiveResource::Base.new(:name => 'grady')
+    PassiveResource::Base::HASH_METHODS.all? {|m| instance.respond_to?(m)}.should eq(true)
+  end
+  
+  it "should respond to created methods" do
+    instance = PassiveResource::Base.new(:name => 'grady')
+    instance.respond_to?('name').should eq(true)
+  end
+end
+  
+describe PassiveResource::Base, "#seedling" do
+  it "should have a seedling equal to the hash" do
+    instance = PassiveResource::Base.new(:name => 'grady')
+    instance.seedling['name'].should eq('grady')
+  end
+end
+
+describe PassiveResource::Base, "#many" do
+  it "should return a collection of PassiveResource::Base objects" do
+    instances = PassiveResource::Base.many(:cities => [{:city => 'Orlando'}, {:city => 'Greenwood'}])
+    instances.all? {|item| item.is_a?(PassiveResource::Base)}.should eq(true)
+  end
+end
+
+describe PassiveResource::Base, "#inspect" do
+  it "should return the seedling to_s" do
+    instance = PassiveResource::Base.new(:name => 'grady')
+    instance.inspect.should eq("{\"name\"=>\"grady\"}")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'passive_resource'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: passive_resource
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Grady Griffin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70256019607440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256019607440
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70256019606840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256019606840
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70256020759600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256020759600
+description: Creates Ruby objects from JSON requested from apis or hashes
+email:
+- gradyg@izea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- lib/passive_resource.rb
+- lib/passive_resource/base.rb
+- lib/passive_resource/error.rb
+- lib/passive_resource/version.rb
+- passive_resource.gemspec
+- spec/.rspec
+- spec/base_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: passive_resource
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple objects from json
+test_files:
+- spec/base_spec.rb
+- spec/spec_helper.rb