restrack-client 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specifying gem's dependencies in restrack-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    restrack-client (0.0.0)
+      i18n
+      json
+      mime-types
+      xml-simple (>= 1.0.13)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    i18n (0.5.0)
+    json (1.5.1)
+    mime-types (1.16)
+    shoulda (2.11.3)
+    xml-simple (1.0.14)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  restrack-client!
+  shoulda

data/README.markdown

@@ -0,0 +1,33 @@
+# RESTRack::Client
+
+A library for interacting with RESTful web services.  Use this to communicate with RESTRack based services.
+
+
+## Usage
+    
+    uri = URI.new('http://localhost')
+    client = RESTRackClient.new(uri)
+    client = RESTRackClient.new('http://localhost')
+    foo_resource = client.foo(123)                                    # pivot object that hasn't yet made request
+    foo = foo_resource.get( { :data => 'something_here' } )           # request is made to GET /foo/123
+    bar = client.foo(123).bar                                         # pivot object that hasn't yet made request
+    bar.delete                                                        # request is made to DELETE /foo/123/bar
+    bar = client.foo(123).bar.post( { :data => 'something_here' } )   # request is made to POST /foo/123/bar
+
+
+## License
+
+Copyright (c) 2011 Chris St. John
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => [:test]
+
+desc 'Run tests.'
+Rake::TestTask.new('test') { |t|
+  t.pattern = 'test/**/*.rb'
+}

data/lib/restrack-client/version.rb

@@ -0,0 +1,3 @@
+module RESTRackClient
+  VERSION = "0.0.0"
+end

data/lib/restrack-client.rb

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'mime/types'
+require 'net/http'
+require 'json'
+require 'xmlsimple'
+
+module RESTRack
+  class Client
+    
+    def initialize(uri, format=:JSON)
+      @uri = URI.parse(uri) unless uri.is_a? URI
+      @path = ''
+      @format = format
+    end
+    
+    def method_missing(resource_name, *args)
+      @path << '/' + resource_name.to_s + '/' + args.join('/')
+      self
+    end
+    
+    def get
+      request = Net::HTTP::Get.new(@path)
+      response = send request
+      parse response
+    end
+    
+    def delete
+      request = Net::HTTP::Delete.new(@path)
+      response = send request
+      parse response
+    end
+    
+    def post(data=nil)
+      request = Net::HTTP::Post.new(@path, {'Content-Type' => content_type })
+      request.body = prepare data unless data.nil?
+      response = send request
+      parse response
+    end
+    
+    def put(data=nil)
+      request = Net::HTTP::Put.new(@path, {'Content-Type' => content_type })
+      request.body = prepare data unless data.nil?
+      response = send request
+      parse response
+    end
+
+    private
+    def content_type
+      RESTRack.mime_type_for(@format).to_s
+    end
+    
+    def prepare(data)
+      case @format
+      when :JSON
+        data = data.to_json
+      when :XML
+        data = XmlSimple.xml_out(data, 'AttrPrefix' => true, 'XmlDeclaration' => true, 'NoIndent' => true)
+      when :YAML
+        data = YAML.dump(data)
+      when :TEXT
+        data = data.to_s
+      end
+      data
+    end
+    
+    def send(request)
+      response = Net::HTTP.start(@uri.host, @uri.port) { |http| http.request(request) }
+      unless response.kind_of?(Net::HTTPSuccess)
+        e = RuntimeError.new("#{request.method} #{request.path} - #{res.code}:#{res.message}\n#{res.body}")
+        raise e
+      end
+      response
+    end
+    
+    def parse(response)
+      mime_type = MIME::Type.new( response.content_type )#response['content-type'] )
+      if mime_type.like?( RESTRack.mime_type_for( :JSON ) )
+        return JSON.parse( response.body )
+      elsif mime_type.like?( RESTRack.mime_type_for( :XML ) )
+        return XmlSimple.xml_in( response.body, 'ForceArray' => false )
+      else
+        return response.body
+      end
+    end
+  end
+end
+
+# XXX - code smells this is also in RESTRack lib/support.rb
+module RESTRack
+  def self.mime_type_for(format)
+    MIME::Types.type_for(format.to_s.downcase)[0]
+  end
+end
+MIME::Types['text/plain'][0].extensions << 'text'
+MIME::Types.index_extensions( MIME::Types['text/plain'][0] )
+# -------------------------------------------------------/

data/restrack-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "restrack-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "restrack-client"
+  s.version     = RESTRackClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Chris St. John']
+  s.email       = ['chris@stjohnstudios.com']
+  s.homepage    = 'http://github.com/stjohncj/RESTRack-Client'
+  s.summary     = %q{A library for interacting with RESTful web services.  Use this to communicate with RESTRack based services.}
+  s.description = %q{A library for interacting with RESTful web services.  Use this to communicate with RESTRack based services.}
+  s.rubyforge_project = "restrack-client"
+  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_development_dependency 'shoulda'
+  s.add_runtime_dependency 'mime-types'
+  s.add_runtime_dependency 'i18n'
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'xml-simple', '>= 1.0.13'
+  
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'restrack-client'
+
+class Test::Unit::TestCase
+end

data/test/test_app/config/constants.yaml

@@ -0,0 +1,24 @@
+#GENERATOR-CONST# -DO NOT REMOVE OR CHANGE THIS LINE- Application-Namespace => test_app
+#
+# = constants.yaml
+# This is where RESTRack applications define the constants relevant to their particular
+# application that are used by the RESTRack base classes.
+
+# Application log path definition
+:LOG:                     '/var/log/test_app/test_app.log'
+# Request log path definition
+:REQUEST_LOG:             '/var/log/test_app/test_app.request.log'
+
+# Logger object levels
+:LOG_LEVEL:               :DEBUG
+:REQUEST_LOG_LEVEL:       :DEBUG
+
+# Supported formats are :JSON, :XML, :YAML, :BIN, :TEXT
+:DEFAULT_FORMAT:          :JSON
+# The resource which will handle root level requests where the name is not specified.  Best for users of this not to implement method_missing in their default controller, unless they are checking for bad URI.
+:DEFAULT_RESOURCE:        nil
+
+# These are the resources which can be accessed from the root of your web service. If left empty, all resources are available at the root.
+:ROOT_RESOURCE_ACCEPT:    []
+# These are the resources which cannot be accessed from the root of your web service. Use either this or ROOT_RESOURCE_ACCEPT as a blacklist or whitelist to establish routing (relationships defined in resource controllers define further routing).
+:ROOT_RESOURCE_DENY:      []

data/test/test_app/config.ru

@@ -0,0 +1,3 @@
+# Rails.root/config.ru
+require 'loader'
+run TestApp::WebService.new

data/test/test_app/controllers/parent_controller.rb

@@ -0,0 +1,39 @@
+class TestApp::ParentController < RESTRack::ResourceController
+  
+  has_relationship_to :responses do |id|
+    id
+  end
+
+  def index
+
+  end
+  
+  def create
+
+  end
+
+  def replace
+
+  end
+
+  def destroy
+
+  end
+
+  def show(id)
+
+  end
+
+  def update(id)
+
+  end
+
+  def delete(id)
+
+  end
+
+  def add(id)
+
+  end
+
+end

data/test/test_app/controllers/responses_controller.rb

@@ -0,0 +1,66 @@
+class TestApp::ResponsesController < RESTRack::ResourceController
+
+  def method_missing(method_name, *args)
+    {
+      :method_called => method_name.to_s,
+      :args => args.join(':')
+    }
+  end
+
+  def index
+    {
+      :action => :index
+    }
+  end
+  
+  def create
+    {
+      :action => :create,
+      :data => @input
+    }
+  end
+
+  def replace
+    {
+      :action => :replace,
+      :data => @input
+    }
+  end
+
+  def drop
+    {
+      :action => :destroy
+    }
+  end
+
+  def show(id)
+    {
+      :action => :show,
+      :id => id
+    }
+  end
+
+  def update(id)
+    {
+      :action => :update,
+      :id => id,
+      :data => @input
+    }
+  end
+
+  def destroy(id)
+    {
+      :action => :delete,
+      :id => id
+    }
+  end
+
+  def add(id)
+    {
+      :action => :add,
+      :id => id,
+      :data => @input
+    }
+  end
+
+end

data/test/test_app/loader.rb

@@ -0,0 +1,21 @@
+require 'restrack'
+
+module TestApp; end
+class TestApp::WebService < RESTRack::WebService; end
+
+RESTRack::CONFIG = RESTRack::load_config(File.join(File.dirname(__FILE__), 'config/constants.yaml'))
+RESTRack::CONFIG[:ROOT] = File.dirname(__FILE__)
+
+# Dynamically load all controllers
+Find.find(  File.join(File.dirname(__FILE__), 'controllers') ) do |file|
+  next if File.extname(file) != '.rb'
+  require file
+end
+
+if File.directory?( File.join(File.dirname(__FILE__), 'models') )
+  # Dynamically load all models
+  Find.find(  File.join(File.dirname(__FILE__), 'models') ) do |file|
+    next if File.extname(file) != '.rb'
+    require file
+  end
+end

data/test/test_restrack-client.rb

@@ -0,0 +1,168 @@
+require File.join( File.dirname(__FILE__ ), 'helper' )
+
+class TestRESTRackClient < Test::Unit::TestCase
+  
+  context 'instantiation' do
+    should 'accept a String URI' do
+      assert_nothing_raised { client_1 = RESTRack::Client.new('http://localhost:9292') }
+    end
+    should 'accept a URI object' do
+      uri = URI.parse('http://localhost:9292')
+      assert_nothing_raised { client_2 = RESTRack::Client.new(uri) }
+    end
+  end
+  
+  should 'get a resource' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    get_response = nil
+    assert_nothing_raised do
+      get_response = client.responses(1).get
+    end
+    expected_response = { 'action' => 'show', 'id' => '1' }
+    assert_equal expected_response, get_response
+  end
+  should 'get a collection' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    get_response = nil
+    assert_nothing_raised do
+      get_response = client.responses.get
+    end
+    expected_response = { 'action' => 'index' }
+    assert_equal expected_response, get_response
+  end
+  
+  should 'delete a resource' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    delete_response = nil
+    assert_nothing_raised do
+      delete_response = client.responses(1).delete
+    end
+    expected_response = { 'action' => 'delete', 'id' => '1' }
+    assert_equal expected_response, delete_response
+  end
+  should 'delete a collection' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    delete_response = nil
+    assert_nothing_raised do
+      delete_response = client.responses.delete
+    end
+    expected_response = { 'action' => 'destroy' }
+    assert_equal expected_response, delete_response
+  end
+  
+  should 'post a resource' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    post_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      post_response = client.responses(1).post(data)
+    end
+    expected_response = { 'action' => 'add', 'id' => '1', 'data' => data }
+    assert_equal expected_response, post_response
+  end
+  should 'post a collection' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    post_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      post_response = client.responses.post(data)
+    end
+    expected_response = { 'action' => 'create', 'data' => data }
+    assert_equal expected_response, post_response
+  end
+  
+  should 'put a resource' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    put_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      put_response = client.responses(1).put(data)
+    end
+    expected_response = { 'action' => 'update', 'id' => '1', 'data' => data }
+    assert_equal expected_response, put_response
+  end
+  should 'put a collection' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    put_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      put_response = client.responses.put(data)
+    end
+    expected_response = { 'action' => 'replace', 'data' => data }
+    assert_equal expected_response, put_response
+  end
+  
+  should 'send and parse response json data' do
+    client = RESTRack::Client.new('http://localhost:9292', :JSON)
+    post_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      post_response = client.responses(1).post(data)
+    end
+    expected_response = { 'action' => 'add', 'id' => '1', 'data' => data }
+    assert_equal expected_response, post_response
+  end
+  should 'send and parse response xml data' do
+    client = RESTRack::Client.new('http://localhost:9292', :XML)
+    post_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      post_response = client.responses(1).post(data)
+    end
+    expected_response = { 'action' => 'add', 'id' => '1', 'data' => data }
+    assert_equal expected_response, post_response
+  end
+  #should 'send and parse response yaml data' do
+  #  client = RESTRack::Client.new('http://localhost:9292', :YAML)
+  #  post_response = nil
+  #  data = {
+  #    'test' => 'data'
+  #  }
+  #  assert_nothing_raised do
+  #    post_response = client.responses(1).post(data)
+  #  end
+  #  expected_response = { 'action' => 'add', 'id' => '1', 'data' => data }
+  #  assert_equal expected_response, post_response
+  #end
+  should 'allow building of request path prior to request' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    object = client.responses(1)
+    assert object.class.to_s, 'RESTRack::Client'
+    assert object.const_get(:path), '/responses/1'
+  end
+  should 'pivot' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    object = client.responses(1)
+    get_response = nil
+    assert_nothing_raised do
+      get_response = object.get
+    end
+    expected_response = { 'action' => 'show', 'id' => '1' }
+    assert_equal expected_response, get_response
+  end
+  should 'walk a relation path to a child resource' do
+    client = RESTRack::Client.new('http://localhost:9292')
+    post_response = nil
+    data = {
+      'test' => 'data'
+    }
+    assert_nothing_raised do
+      post_response = client.parent(1).responses.post(data)
+    end
+    expected_response = { 'action' => 'add', 'id' => '1', 'data' => data }
+    assert_equal expected_response, post_response
+  end
+  
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: restrack-client
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Chris St. John
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.13
+  type: :runtime
+  version_requirements: *id005
+description: A library for interacting with RESTful web services.  Use this to communicate with RESTRack based services.
+email: 
+- chris@stjohnstudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/restrack-client.rb
+- lib/restrack-client/version.rb
+- restrack-client.gemspec
+- test/helper.rb
+- test/test_app/config.ru
+- test/test_app/config/constants.yaml
+- test/test_app/controllers/parent_controller.rb
+- test/test_app/controllers/responses_controller.rb
+- test/test_app/loader.rb
+- test/test_restrack-client.rb
+has_rdoc: true
+homepage: http://github.com/stjohncj/RESTRack-Client
+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: restrack-client
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A library for interacting with RESTful web services.  Use this to communicate with RESTRack based services.
+test_files: 
+- test/helper.rb
+- test/test_app/config.ru
+- test/test_app/config/constants.yaml
+- test/test_app/controllers/parent_controller.rb
+- test/test_app/controllers/responses_controller.rb
+- test/test_app/loader.rb
+- test/test_restrack-client.rb