kelredd-resourceful 0.1.1 → 0.2.0

data/Rakefile

@@ -21,7 +21,7 @@ spec = Gem::Specification.new do |s|
   
   s.add_dependency('nokogiri')
   s.add_dependency('json')
-  s.add_dependency('rest_client')
+  s.add_dependency('rest-client')
   s.add_dependency('log4r')
   s.add_dependency('kelredd-useful')
 end

data/features/resource_models.feature

@@ -0,0 +1,26 @@
+Feature: Resource Models
+  In order to consume rest based resources
+  As an object
+  I want to define and initialize a model class from xml resource data
+  
+  Scenario: Get JSON user
+    Given I have a configured resource host
+    And I am user with the screen_name "kelredd"
+    When I load my "Json" user model
+    Then the result should be a valid User model
+    
+  Scenario: Get XML user
+    Given I have a configured resource host
+    And I am user with the screen_name "kelredd"
+    When I load my "Xml" user model
+    Then the result should be a valid User model
+
+  Scenario: Get JSON status collection
+    Given I have a configured resource host
+    When I load the "Json" status "public_timeline"
+    Then the result should be a collection of valid Status models
+    
+  Scenario: Get XML status collection
+    Given I have a configured resource host
+    When I load the "Xml" status "public_timeline"
+    Then the result should be a collection of valid Status models

data/features/step_definitions/resource_models_steps.rb

@@ -0,0 +1,54 @@
+Given /^I am user with the screen_name "([^\"]*)"$/ do |screen_name|
+  @screen_name = screen_name
+end
+
+When /^I load my "([^\"]*)" user model$/ do |klass|
+  name = "User#{klass}"
+  constant = ::Object
+  model_klass = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+  @result = model_klass.find(@screen_name)
+end
+
+When /^I load the "([^\"]*)" status "([^\"]*)"$/ do |klass, collection|
+  name = "Status#{klass}"
+  constant = ::Object
+  model_klass = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+  @result = model_klass.find(collection)
+end
+
+Then /^the result should be a valid User model$/ do
+  [:id, :name, :screen_name, :location, :description, :profile_image_url, :url, :protected, :followers_count, :friends_count, :created_on, :last_status_at, :last_status].each do |attribute|
+    assert @result.respond_to?(attribute)
+  end
+  {
+    :id => 38225297,
+    :name => "Kelly Redding",
+    :screen_name => "kelredd",
+    :protected => false,
+    :created_on => Date.strptime("2009-05-06")
+  }.each do |k,v|
+    assert_equal v, @result.send(k.to_s)
+  end
+  assert_kind_of DateTime, @result.last_status_at
+  assert !@result.last_status.nil?
+  assert @result.last_status != ''
+end
+
+Then /^the result should be a collection of valid Status models$/ do
+  assert_kind_of Array, @result
+  assert_equal 20, @result.length
+
+  [:id, :text, :source, :truncated, :favorited, :reply_status, :reply_user, :user_id, :user_screen_name, :user].each do |attribute|
+    assert @result.first.respond_to?(attribute)
+    assert_nothing_raised do
+      @result.first.send(attribute.to_s)
+    end
+  end
+  
+  [:id, :text, :truncated, :favorited, :user_id, :user_screen_name, :user].each do |attribute|
+    assert !@result.first.send(attribute.to_s).nil?
+  end
+  
+  assert_kind_of Resourceful::Model::Base, @result.first.user  
+  
+end

data/features/step_definitions/support/models.rb

@@ -0,0 +1,89 @@
+class UserXml < Resourceful::Model::Xml
+  
+  def self.find(screen_name, force=false)
+    get("/users/#{screen_name}", {}, "//user")
+  end
+  
+  attribute :id, :integer
+  attribute :name, :string
+  attribute :screen_name, :string
+  attribute :location, :string
+  attribute :description, :string
+  attribute :profile_image_url, :string
+  attribute :url, :string
+  attribute :protected, :boolean
+  attribute :followers_count, :integer
+  attribute :friends_count, :integer
+  attribute :created_on, :date, :path => 'created_at'
+  attribute :last_status_at, :datetime, :path => "status/created_at"
+  attribute :last_status, :string, :path => "status/text"
+
+end
+
+class UserJson < Resourceful::Model::Json
+  
+  def self.find(screen_name, force=false)
+    get("/users/#{screen_name}", {})
+  end
+  
+  attribute :id, :integer
+  attribute :name, :string
+  attribute :screen_name, :string
+  attribute :location, :string
+  attribute :description, :string
+  attribute :profile_image_url, :string
+  attribute :url, :string
+  attribute :protected, :boolean
+  attribute :followers_count, :integer
+  attribute :friends_count, :integer
+  attribute :created_on, :date, :path => 'created_at'
+  attribute :last_status_at, :datetime, :path => "status/created_at"
+  attribute :last_status, :string, :path => "status/text"
+
+end
+
+class StatusXml < Resourceful::Model::Xml
+  
+  def self.find(collection, force=false)
+    get_collection("/statuses/#{collection}", {}, "//statuses/status")
+  end
+  
+  attribute :id, :integer
+  attribute :text, :string
+  attribute :source, :string
+  attribute :created_on, :date, :path => 'created_at'
+  attribute :truncated, :boolean
+  attribute :favorited, :boolean
+  attribute :reply_status, :integer, :path => 'in_reply_to_status_id'
+  attribute :reply_user, :integer, :path => 'in_reply_to_user_id'
+  attribute :user_id, :integer, :path => "user/id"
+  attribute :user_screen_name, :integer, :path => "user/screen_name"
+
+  def user
+    @user ||= (get_node('./user') ? UserXml.new(get_node('./user')) : nil)
+  end
+  
+end
+
+class StatusJson < Resourceful::Model::Json
+  
+  def self.find(collection, force=false)
+    get_collection("/statuses/#{collection}", {})
+  end
+  
+  attribute :id, :integer
+  attribute :text, :string
+  attribute :source, :string
+  attribute :created_on, :date, :path => 'created_at'
+  attribute :truncated, :boolean
+  attribute :favorited, :boolean
+  attribute :reply_status, :integer, :path => 'in_reply_to_status_id'
+  attribute :reply_user, :integer, :path => 'in_reply_to_user_id'
+  attribute :user_id, :integer, :path => "user/id"
+  attribute :user_screen_name, :integer, :path => "user/screen_name"
+
+  def user
+    @user ||= UserXml.find(self.user_screen_name)
+  end
+
+end

data/features/step_definitions/support/resources.rb

@@ -17,3 +17,4 @@ Given /^I have a configured resource host set to log$/ do
     RESOURCE_CONFIG[:log]
   }
 end
+

data/lib/resourceful/exceptions.rb

@@ -1,10 +1,22 @@
 module Resourceful
   module Exceptions
   
-    class ConfigurationError < ::StandardError
+    class ResourcefulError < ::StandardError
     end
     
-    class FormatError < ::StandardError
+    class ResourceError < ResourcefulError
+    end
+    
+    class ConfigurationError < ResourceError
+    end
+    
+    class FormatError < ResourceError
+    end
+    
+    class ModelError < ResourcefulError
+    end
+    
+    class AttributeError < ModelError
     end
     
   end

data/lib/resourceful/extensions.rb

@@ -0,0 +1,72 @@
+module Resourceful
+  module Extensions   
+    module String
+      
+      module ClassMethods; end
+      def self.included(klass)
+        klass.extend(ClassMethods) if klass.kind_of?(Class)
+      end
+
+      module ClassMethods
+      end
+
+      unless "".respond_to?(:to_datetime) 
+        def to_datetime
+          ::DateTime.civil(*::Date._parse(self, false).values_at(:year, :mon, :mday, :hour, :min, :sec).map { |arg| arg || 0 }) rescue nil
+        end
+      end
+
+      unless "".respond_to?(:to_datetime) 
+        def to_date
+          ::Date.civil(*::Date._parse(self, false).values_at(:year, :mon, :mday).map { |arg| arg || 0 }) rescue nil
+        end
+      end
+      
+      unless "".respond_to?(:to_boolean) 
+        def to_boolean
+          self =~ /^(true|1)$/i ? true : false
+        end
+      end
+      
+    end
+  end
+end
+
+module Resourceful
+  module Extensions
+    module Hash
+
+      module ClassMethods; end
+      def self.included(klass)
+        klass.extend(ClassMethods) if klass.kind_of?(Class)
+      end
+
+      module ClassMethods
+      end
+
+      # Returns string formatted for HTTP URL encoded name-value pairs.
+      # For example,
+      #  {:id => 'thomas_hardy'}.to_http_query_str 
+      #  # => "?id=thomas_hardy"
+      #  {:id => 23423, :since => Time.now}.to_http_query_str
+      #  # => "?since=Thu,%2021%20Jun%202007%2012:10:05%20-0500&id=23423"
+      unless {}.respond_to?(:to_http_query_str) 
+        def to_http_query_str(opts = {})
+          require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+          opts[:prepend] ||= '?'
+          opts[:append] ||= ''
+          self.empty? ? '' : "#{opts[:prepend]}#{self.collect{|key, val| "#{key.to_s}=#{CGI.escape(val.to_s)}"}.join('&')}#{opts[:append]}"
+        end
+      end
+      
+    end
+  end
+end
+
+class String
+  include Resourceful::Extensions::String
+end
+
+class Hash
+  include Resourceful::Extensions::Hash
+end

data/lib/resourceful/model/base.rb

@@ -0,0 +1,49 @@
+module Resourceful
+  module Model
+
+    class Base
+      
+      # KDR: override this to have a per model Resource handler
+      # => TODO: need to support creating resource instances first though
+      def self.resource
+        Resourceful::Resource
+      end
+      
+      def self.get(path, opts={}, force=false)
+        resource.get(path, opts, force)
+      end
+      def self.get_collection(path, opts={}, force=false)
+        (yield resource.get(path, opts, force)).collect{|data| new(data)}
+      end
+
+      def initialize(data)
+      end
+      
+      protected
+      
+      def self.attribute(name, type, config)
+        content_method = case type.to_sym
+        when :string
+          'to_s'
+        when :integer
+          'to_i'
+        when :float
+          'to_f'
+        when :date
+          'to_date'
+        when :datetime
+          'to_datetime'
+        when :boolean
+          'to_boolean'
+        else 
+          'to_s'
+        end
+        define_method(name) do
+          instance_variable_get("@#{name}") || instance_variable_set("@#{name}", ((a = attribute(config)) && a.kind_of?(String)) ? a.send(content_method) : a)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/resourceful/model/json.rb

@@ -0,0 +1,48 @@
+module Resourceful
+  module Model
+
+    class Json < Resourceful::Model::Base
+      
+      attr_reader :json
+
+      def self.get(path, params, force=false)
+        opts = {
+          :format => 'json',
+          :params => params || {}
+        }
+        new(super(path, opts, force))
+      end
+      def self.get_collection(path, params, force=false)
+        opts = {
+          :format => 'json',
+          :params => params || {}
+        }
+        super(path, opts, force) do |data|
+          data
+        end
+      end
+
+      def initialize(json)
+        @json = json
+      end
+      
+      protected
+      
+      def self.attribute(name, type, config={})
+        config[:path] ||= name
+        super(name, type, config)
+      end
+      
+      def attribute(config)
+        paths = config[:path].to_s.split('/')
+        paths.inject(@json) do |val,path|
+          #raise Resourceful::Exceptions::AttributeError, "no matching attribute data for'#{config[:path]}'" if val.nil?
+          val.fetch(path, nil) rescue nil
+        end
+      end
+        
+
+    end
+
+  end
+end

data/lib/resourceful/model/xml.rb

@@ -0,0 +1,59 @@
+module Resourceful
+  module Model
+
+    class Xml < Resourceful::Model::Base
+      
+      attr_reader :xml
+
+      def self.get(path, params, xpath, force=false)
+        opts = {
+          :format => 'xml',
+          :params => params || {}
+        }
+        new(super(path, opts, force).xpath(xpath))
+      end
+      def self.get_collection(path, params, xpath, force=false)
+        opts = {
+          :format => 'xml',
+          :params => params || {}
+        }
+        super(path, opts, force) do |data|
+          data.xpath(xpath)
+        end
+      end
+
+      def initialize(xml)
+        @xml = xml
+      end
+      
+      protected
+      
+      def self.attribute(name, type, config={})
+        config[:path] ||= name
+        super(name, type, config)
+      end
+      
+      def attribute(config)
+        node = get_node("./#{config[:path]}")
+        #raise Resourceful::Exceptions::AttributeError, "no matching attribute data for'#{config[:path]}'" unless node
+        node.content rescue nil
+      end
+        
+      def self.get_node(xml, path)
+        xml.xpath(path.to_s).first
+      end
+      def get_node(path)
+        self.class.get_node(@xml, path)
+      end
+
+      def self.xml_root_name(xml)
+        xml.root.name
+      end
+      def xml_root_name
+        self.class.xml_root_name(@xml)
+      end
+
+    end
+
+  end
+end

data/lib/resourceful/model.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), "model" ,"*.rb")].each do |file|
+  require file
+end

data/lib/resourceful/resource/format.rb

@@ -41,7 +41,7 @@ module Resourceful
       end
         
       def self.build(json_str)
-        Hash.from_json(json_str.to_s)
+        JSON.parse(json_str.to_s)
       end
         
     end

data/lib/resourceful/version.rb

@@ -2,8 +2,8 @@ module Resourceful
   module Version
     
     MAJOR = 0
-    MINOR = 1
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/lib/resourceful.rb

@@ -1,10 +1,7 @@
-require 'rubygems'
-require 'nokogiri'
-require 'json'
-require 'rest_client'
-require 'log4r'
-require 'useful/ruby_extensions'
+%w(rubygems nokogiri json rest_client log4r).each do |lib|
+  require lib
+end
 
-require File.join(File.dirname(__FILE__), 'resourceful', 'exceptions.rb')
-require File.join(File.dirname(__FILE__), 'resourceful', 'resource.rb')
-#require File.join(File.dirname(__FILE__), 'resourceful', 'resource.rb')
+%w(exceptions extensions resource model).each do |file|
+  require File.join(File.dirname(__FILE__), 'resourceful', "#{file}.rb")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kelredd-resourceful
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-21 00:00:00 -07:00
+date: 2009-07-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: rest_client
+  name: rest-client
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -75,15 +75,24 @@ files:
 - Rakefile
 - features/config_resource.feature
 - features/get_resource.feature
+- features/resource_models.feature
 - features/step_definitions
 - features/step_definitions/resource_config_steps.rb
 - features/step_definitions/resource_get_steps.rb
+- features/step_definitions/resource_models_steps.rb
 - features/step_definitions/support
 - features/step_definitions/support/env.rb
 - features/step_definitions/support/helpers.rb
+- features/step_definitions/support/models.rb
 - features/step_definitions/support/resources.rb
 - lib/resourceful
 - lib/resourceful/exceptions.rb
+- lib/resourceful/extensions.rb
+- lib/resourceful/model
+- lib/resourceful/model/base.rb
+- lib/resourceful/model/json.rb
+- lib/resourceful/model/xml.rb
+- lib/resourceful/model.rb
 - lib/resourceful/resource
 - lib/resourceful/resource/base.rb
 - lib/resourceful/resource/cache.rb