rest_resource 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@rest_resource

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec rake spec"
+rvm:
+  - ree
+  - 1.9.2
+notifications:
+  email:
+    - dev@whiteglove.com

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'rest-client'
+gem 'active_support'
+gem 'rake'
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    diff-lcs (1.1.3)
+    mime-types (1.16)
+    rake (0.9.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  rake
+  rest-client
+  rspec

data/README.md

@@ -0,0 +1,30 @@
+rest_resource -- rest-client gem wrapper to provide a simple CRUD interface
+====================================
+
+[![Build Status](https://secure.travis-ci.org/ywen/rest_resource.png)](http://travis-ci.org/ywen/rest_resource)
+
+
+## DESCRIPTION
+The gem provides a basic CRUD operation to the resources. It is basically rest-client wrapper. Once you use it, you have find, create, update and delete (Currently I implemented only find and create)
+
+## USAGE
+Given you need to fetch user from a web service. You can write:
+
+    class User < RestResource::Resource
+       class << self
+         def url
+           "http://www.example.com/users"
+         end
+       end
+    end
+
+To use it, you can just do:
+    
+    User.find 1
+
+    User.create :name => "Leslie Cheung", :login => "singer"
+
+Both operation assume your web service controller returns a json string which can be initialized into an object.
+
+##Contributors
+* Yi Wen

data/Rakefile

@@ -0,0 +1,2 @@
+import File.join(File.expand_path(File.dirname(__FILE__)), "tasks", "rspec.rake")
+require 'bundler/gem_tasks'

data/lib/rest_resource.rb

@@ -0,0 +1,6 @@
+require "rest_resource/version"
+require 'rubygems'
+require 'rest-client'
+require 'active_support'
+require 'rest_resource/rest_crud'
+require 'rest_resource/resource'

data/lib/rest_resource/resource.rb

@@ -0,0 +1,34 @@
+module RestResource
+  class Resource
+    attr_reader :attributes
+    private :attributes
+
+    class << self
+      def find(resource_id)
+        self.new(rest_crud.find(resource_id))
+      end
+
+      def create(params)
+        self.new(rest_crud.create(params))
+      end
+
+      private
+
+      def rest_crud
+        RestCrud.new(url)
+      end
+    end
+
+    def initialize(params={})
+      params_hash = ActiveSupport::JSON.decode params
+      @attributes = params_hash
+      (class << self; self; end).class_eval do
+        params_hash.each_pair do |method_name, value|
+          define_method(method_name) do
+            value
+          end
+        end
+      end
+   end
+  end
+end

data/lib/rest_resource/rest_crud.rb

@@ -0,0 +1,17 @@
+module RestResource
+  class RestCrud
+    attr_reader :url
+    private :url
+    def initialize(url)
+      @url = url
+    end
+
+    def find(resource_id)
+      RestClient.get "#{url}/#{resource_id}.json"
+    end
+
+    def create(params)
+      RestClient.post "#{url}.json", params
+    end
+  end
+end

data/lib/rest_resource/version.rb

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

data/rest_resource.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rest_resource/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rest_resource"
+  s.version     = RestResource::VERSION
+  s.authors     = ["Yi Wen"]
+  s.email       = ["hayafirst@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A wrapper over rest-client providing basic CRUD restful web service operation}
+  s.description = %q{A wrapper over rest-client providing basic CRUD restful web service operation}
+
+  s.rubyforge_project = "rest_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"]
+  s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+  s.add_runtime_dependency(%q<active_support>, [">= 0"])
+end

data/spec/rest_resource/resource_spec.rb

@@ -0,0 +1,63 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+module RestResource
+  describe Resource do
+    let(:rest_crud) {double :rest_crud, :find => "{}", :create => "{}"}
+    let(:find_params) {123}
+    let(:create_params) {{"attr1" => "val1"}}
+    let(:klass) {
+      Class.new(Resource) do
+      def self.url
+        "http://www.example.com/resources"
+      end
+      end
+    }
+
+    %w(find create).each do |method_name|
+      describe ".#{method_name}" do
+        before(:each) do
+          RestCrud.stub(:new).and_return rest_crud
+        end
+
+
+        it "should initialize a rest crud object" do
+          RestCrud.should_receive(:new).with("http://www.example.com/resources").and_return rest_crud
+          klass.send(method_name, send("#{method_name}_params"))
+        end
+
+        it "should ask rest crud to do the finding" do
+          rest_crud.should_receive(method_name).with(send("#{method_name}_params"))
+          klass.send(method_name, send("#{method_name}_params"))
+        end
+
+        it "should intialize a resource object" do
+          rest_crud.stub(:find).and_return(ActiveSupport::JSON.encode("attr1" => "val1", "attr2" => "val2"))
+          object = klass.send(method_name, send("#{method_name}_params"))
+          object.should be_a klass
+        end
+
+      end
+    end
+
+    describe ".new" do
+      let(:params) { ActiveSupport::JSON.encode( {"attr1" => "val1", "attr2" => "val2"} ) }
+      let(:resource) {klass.new(params)}
+      {"attr1" => "val1", "attr2" => "val2"}.each_pair do |attr, val|
+        it "should generate '#{attr}' method and return '#{val}'" do
+          resource.send(attr).should == val
+        end
+      end
+
+      context "when the objects are initialized multiple times" do
+        attr_reader :resource1
+        before(:each) do
+          @resource1 = klass.new( ActiveSupport::JSON.encode("attr1" => "val1"))
+          klass.new( ActiveSupport::JSON.encode("attr1" => "val2"))
+        end
+
+        it "should work" do
+          resource1.attr1.should == "val1"
+        end
+      end
+    end
+      end
+  end

data/spec/rest_resource/rest_crud_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+
+module RestResource
+  describe RestCrud do
+    subject {RestCrud.new("http://example.com/resources")}
+    describe ".find" do
+      it "should get the resource specified" do
+        RestClient.should_receive(:get).with("http://example.com/resources/123.json")
+        subject.find 123
+      end
+    end
+
+    describe ".create" do
+      it "should post the resource specified" do
+        RestClient.should_receive(:post).with("http://example.com/resources.json", {:param1 => "value1", :param2 => "values2"})
+        subject.create({:param1 => "value1", :param2 => "values2"})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rspec'
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+end
+require File.join(File.expand_path(File.dirname(__FILE__)), "../lib", "rest_resource")

data/tasks/rspec.rake

@@ -0,0 +1,17 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  spec_prereq = :noop
+  task :noop do
+  end
+
+  desc "Run all specs in spec directory (excluding plugin specs)"
+  RSpec::Core::RakeTask.new(:spec => spec_prereq) do |t|
+    t.rspec_opts = ["--format", "documentation", "--colour"]
+    t.pattern = "spec/**/*_spec.rb"
+  end
+
+rescue LoadError => e
+  p e
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: rest_resource
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Yi Wen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A wrapper over rest-client providing basic CRUD restful web service operation
+email: 
+- hayafirst@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rest_resource.rb
+- lib/rest_resource/resource.rb
+- lib/rest_resource/rest_crud.rb
+- lib/rest_resource/version.rb
+- rest_resource.gemspec
+- spec/rest_resource/resource_spec.rb
+- spec/rest_resource/rest_crud_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rest_resource
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A wrapper over rest-client providing basic CRUD restful web service operation
+test_files: 
+- spec/rest_resource/resource_spec.rb
+- spec/rest_resource/rest_crud_spec.rb
+- spec/spec_helper.rb