musashi 0.0.1.b1

data/README.rdoc

@@ -0,0 +1,87 @@
+=Musashi
+
+Musashi is a RestClient that follows relations or links.
+
+=Example
+
+==Protocol
+
+  curl -i http://foo.com/customers/1
+  {
+    "id":    "1",
+    "login": "foo",
+    "name":  "Foo Bar",
+    "phones": [
+      {
+        "number": "51156782323",
+        "extension": ""
+      },
+      {
+        "number": "51156782323",
+        "extension": "2345"
+      }
+    ],
+    "emails": ["foo@gmail.com",
+               "foo.bar@gmail.com.br",
+               "foo+you@gmail.com.br"],
+    "address": {
+      "street":      "No Where",
+      "number":      "123",
+      "complement":  "4-F",
+      "district":    "Pinheiros",
+      "city":        "São Paulo",
+      "state":       "SP",
+      "country":     "Brazil",
+      "postal_code": "000000"
+    },
+    "link": [
+      {
+        "rel":  "items",
+        "href": "http://bar.com/customers/1/items"
+      }
+    ]
+  }
+
+  curl -i http://bar.com/customer/1/items
+  {"entries" : 
+    [ "http://bazz.com/items/1", "http://bazz.com/items/2" ]
+  }
+
+  curl -i http://bazz.com/items/1
+  {"name":"bazz item"}
+
+==Code
+
+===With class
+
+  require 'musashi'
+  class Customer
+    include Musashi::Retriever
+    include Musashi::Resource::JSON
+    attr_accessor :id
+    endpoint = '"http://foo.com/customers/#{id}"'
+  end
+
+  customer.id = '1'
+  puts customer.login
+  puts customer.phones.first.number
+  puts customer.email.first
+  puts customer.address.number
+  customer.items.entries.each do |i|
+    puts i.name
+  end
+
+===Without class
+
+  require 'musashi'
+  customer = Musashi::Resource.new('http://foo.com/customer/1', :format => :json)
+
+  puts custome.id
+  puts customer.login
+  puts customer.phones.first.number
+  puts customer.email.first
+  puts customer.address.number
+  customer.items.entries.each do |i|
+    puts i.name
+  end
+

data/Rakefile

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'musashi/version'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec) 
+
+desc 'Run the gem build'
+task :build do
+  system 'gem build musashi.gemspec'
+end
+ 
+desc 'Run the gem push'
+task :release => [:spec, :build] do
+  system "gem push musashi-#{Musashi::VERSION}.gem"
+end
+
+desc 'Run the unit suite'
+task :default => [:spec]
+

data/lib/faraday/response/raise_http_4xx.rb

@@ -0,0 +1,41 @@
+module Faraday
+  class Response::RaiseHttp4xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise "BadRequest-#{error_message(env)}"
+      when 401
+        raise "Unauthorized-#{error_message(env)}"
+      when 403
+        raise "Forbidden-#{error_message(env)}"
+      when 404
+        raise "NotFound-#{error_message(env)}"
+      when 406
+        raise "NotAcceptable-#{error_message(env)}"
+      when 420
+        raise "EnhanceYourCalm-#{error_message(env)}"
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]}#{error_body(env[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = Array(body['errors']).first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_http_5xx.rb

@@ -0,0 +1,23 @@
+module Faraday
+
+  class Response::RaiseHttp5xx < Response::Middleware
+
+    def on_complete(env)
+      case env[:status].to_i
+      when 500
+        raise "InternalServerError-#{error_message(env)}"
+      when 502
+        raise "BadGateway-#{error_message(env)}"
+      when 503
+        raise "ServiceUnavailable-#{error_message(env)}"
+      end
+    end
+
+    private
+
+    def error_message(env, body=nil)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{[env[:status].to_s + ':', body].compact.join(' ')}"
+    end
+
+  end
+end

data/lib/musashi.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require 'active_support/core_ext/integer'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/module'
+require 'faraday'
+require 'faraday_middleware'
+require 'yaml'
+
+require 'faraday/response/raise_http_4xx'
+require 'faraday/response/raise_http_5xx'
+require 'musashi/version'
+require 'musashi/connection'
+require 'musashi/retriever'
+require 'musashi/resource'
+

data/lib/musashi/connection.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+module Musashi::Connection
+
+  attr_accessor :endpoint
+  attr_accessor_with_default :format, :json
+
+  def options
+    return @options if @options
+    builder = ::Faraday::Builder.new
+    builder.use ::Faraday::Request::Multipart
+    builder.use ::Faraday::Request::UrlEncoded
+    builder.use ::Faraday::Response::RaiseHttp4xx
+    case format.to_s.downcase
+    when 'json'
+      builder.use ::Faraday::Response::Mashify
+      builder.use ::Faraday::Response::ParseJson
+    when 'xml'
+      builder.use ::Faraday::Response::Mashify
+      builder.use ::Faraday::Response::ParseXml
+    end
+    builder.use ::Faraday::Response::RaiseHttp5xx
+    builder.adapter :net_http
+    @options = {
+      :headers => {
+        'Accept' => "application/#{format}",
+        'User-Agent' => "Musashi Gem #{::Musashi::VERSION}"
+      },
+      :url => endpoint,
+      :ssl => {:verify => false},
+      :builder => builder
+    }
+  end
+
+  def connection
+    @connection ||= ::Faraday.new(options)
+  end
+
+end

data/lib/musashi/resource.rb

@@ -0,0 +1,61 @@
+class Musashi::Resource
+  
+  module Format
+
+    def self.formats
+      @@formats ||= {}
+    end
+
+    def retrieve
+      marshalled = super
+      resource_type = Format.formats[format]
+      marshalled.extend(resource_type) unless resource_type.nil?
+      marshalled
+    end
+
+  end
+
+  module JSON 
+    include Format
+    Format.formats[:json] = JSON
+
+    def self.included(clazz)
+      super
+      clazz.extend ClassMethods
+      clazz.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      attr_accessor :endpoint
+    end
+
+    module InstanceMethods
+      def retrieve
+        self.endpoint = eval self.class.endpoint
+        super
+      end
+    end
+
+    def method_missing(sym,*args,&block)
+      super 
+    rescue NoMethodError => error
+      raise error unless retrieved?
+      raise NoMethodError.new(sym) unless respond_to?(:link)
+      selected = link.select{|ln| ln.rel == sym.to_s}
+      raise NoMethodError.new(sym) if selected.nil? or selected.empty?
+      raise "More than one result for #{sym} #{selected.join(',')}" if selected.size > 1
+      selected.first.href
+    end
+
+  end
+
+  include ::Musashi::Retriever::DelegateHash
+  def initialize(url,options={})
+    raise ArgumentError.new('Undefined url') if url.nil? or url.empty?
+    resource_type = Format.formats[ options[:format] || :json ]
+    extend(resource_type) unless resource_type.nil?
+    self.endpoint = url
+  end
+
+end
+

data/lib/musashi/retriever.rb

@@ -0,0 +1,192 @@
+# -*- encoding: utf-8 -*-
+module Musashi::Retriever
+
+  module Base
+    include ::Musashi::Connection
+
+    attr_writer :path
+    def path
+      @path ||= connection.path_prefix
+    end
+
+    def retrieved?
+      @retrieved ||= false
+    end
+
+    def retrieve(header={})
+      response = connection.get(path, header)
+      @retrieved = true
+      response.body.extend(VisitorStrategist)
+    end
+
+  end
+
+  module Strategist
+
+    def self.extend_object(receiver)
+      self.define_by_behavior(receiver)
+    end
+
+    def self.retrievers_by_behavior
+      @@retrievers_by_behavior ||= {}
+    end
+
+    def self.retrievers_by_behavior=(retrievers)
+      @@retrievers_by_behavior = retrievers
+    end
+
+    def self.define_by_behavior(receiver)
+      @@retrievers_by_behavior.each do |retriever|
+        if retriever.extend?(receiver)
+          receiver.extend(retriever)
+          break
+        end
+      end
+    end
+
+    def self.retrievers_by_name
+      @@retrievers_by_name ||= {}
+    end
+
+    def self.retrievers_by_name=(retrievers)
+      @@retrievers_by_name = retrievers
+    end
+
+    def self.define_by_name(receiver,name)
+      raise "Undefined receiver" if receiver.nil?
+      raise "Undefined name for #{receiver}" if name.nil?
+      retriever = @@retrievers_by_name[name]
+      raise "Undefined retriever for #{receiver} with name=#{name}" if retriever.nil?
+      receiver.extend retriever
+    end
+
+    def define(receiver,name=nil)
+      raise "Undefined receiver" if receiver.nil?
+      if name.nil?
+        Strategist.define_by_behavior receiver
+      else
+        retriever = Strategist.retrievers_by_name[name]
+        if retriever.nil?
+          Strategist.define_by_behavior receiver
+        else
+          receiver.extend retriever
+        end
+      end
+    end
+
+  end
+
+  module VisitorStrategist
+    include Base
+    include Strategist
+
+    def self.extend?(receiver)
+      !receiver.nil? && receiver.respond_to?(:keys) && receiver.respond_to?(:fetch)
+    end
+
+    def self.extend_object(receiver)
+      raise RuntimeError.new unless extend? receiver
+      super
+    end
+
+    def [](key)
+      return nil unless self.has_key?(key)
+      value = self.fetch(key.to_s) rescue self.fetch(key) rescue nil
+      return value if value.nil?
+      define value,key.to_sym
+      value
+    end
+
+    def has_key?(key)
+      self.key?(key.to_s) || self.key?(key)
+    end
+
+    def respond_to?(method)
+      self.has_key?(method) ? true : super
+    end
+
+    def method_missing(sym,*args,&block)
+      super unless args.empty?
+      super unless has_key?(sym)
+
+      value = self.fetch(sym.to_s) rescue self.fetch(sym) rescue nil
+      return value if value.nil?
+
+      define value, sym
+      value
+    end
+
+  end
+
+  module DelegateHash
+    include VisitorStrategist
+
+    attr_accessor :attrs
+
+    def [](key)
+      @attrs = retrieve if @attrs.nil?
+      super
+    end
+
+    def method_missing(sym,*args,&block)
+      @attrs = retrieve if @attrs.nil?
+      super
+    end
+
+    def keys
+      @attrs = retrieve if @attrs.nil?
+      @attrs.keys
+    end
+
+    def key?(key)
+      @attrs = retrieve if @attrs.nil?
+      @attrs.key?(key)
+    end
+
+    def fetch(*args)
+      @attrs = retrieve if @attrs.nil?
+      @attrs.fetch(*args)
+    end
+
+  end
+
+  module Content
+    include DelegateHash
+
+    def self.extend?(receiver)
+      !receiver.nil? && receiver.respond_to?(:start_with?) && receiver.start_with?('http')
+    end
+
+    def self.extend_object(receiver)
+      raise RuntimeError.new unless extend? receiver
+      super
+    end
+
+    def retrieve
+      self.endpoint = to_s
+      super
+    end
+    
+  end
+
+  module Iterator
+    def self.extend?(receiver)
+      !receiver.nil? && receiver.is_a?(::Array)
+    end
+
+    def self.extend_object(receiver)
+      raise RuntimeError.new unless extend? receiver
+      receiver.each do |item|
+        item.extend VisitorStrategist
+      end
+    end
+  end
+
+  Strategist.retrievers_by_behavior = [
+    Content,
+    VisitorStrategist,
+    Iterator
+  ]
+
+  include DelegateHash
+end

data/lib/musashi/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module Musashi
+  VERSION = "0.0.1.b1"
+end

data/spec/resource_spec.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Musashi::Resource do
+
+  before(:all) do
+    @customer = Musashi::Resource.new('http://localhost:4567/customers/1.json')
+  end
+
+  it 'should raise an error for undefined method' do
+    lambda{ @resource.foo }.should raise_error(NoMethodError)
+  end
+
+  it 'should retrieve a customer instance' do
+    @customer.id.should eq('1')
+    @customer.cpf.should eq('12345678912')
+  end
+
+  it 'should retrieve relationships' do 
+    @customer.provisionings.entries.each{ |p| p.service_key.should_not be_nil }
+  end
+
+end
+

data/spec/sinatra/app.rb

@@ -0,0 +1,6 @@
+# -*- enconding: utf-8 -*-
+require 'sinatra'
+
+public_dir = File.expand_path('../public/',__FILE__)
+set :public, public_dir
+

data/spec/sinatra/public/customers/1.json

@@ -0,0 +1,65 @@
+{
+    "id": "1",
+    "login": "foo",
+    "name": "Foo Bar",
+    "cpf": "12345678912",
+    "rg": "12345678912",
+    "emails": [
+        "foo@gmail.com"
+    ],
+    "phones": [
+        "11111111",
+        "22222222"
+    ],
+    "address": {
+        "street": "No where",
+        "number": "42",
+        "complement": "apt-42",
+        "district": "Place",
+        "city": "Townsville",
+        "state": "Batman",
+        "country": "BR",
+        "postal_code": "12121212"
+    },
+    "twitter": "foo",
+    "facebook": "foo",
+    "link": [
+        {
+            "rel": "contacts",
+            "href": "http://localhost:4567/customers/1/contacts"
+        },
+        {
+            "rel": "billing_info",
+            "href": "http://localhost:4567/customers/1/billing_info"
+        },
+        {
+            "rel": "billing_contact",
+            "href": "http://localhost:4567/customers/1/billing_contact"
+        },
+        {
+            "rel": "balance",
+            "href": "http://localhost:4567/customers/1/balance"
+        },
+        {
+            "rel": "credit_limit",
+            "href": "http://localhost:4567/customers/1/credit_limit"
+        },
+        {
+            "rel": "manager",
+            "href": "http://localhost:4567/customers/1/manager"
+        },
+        {
+            "rel": "provisionings",
+            "href": "http://localhost:4567/customers/1/provisionings"
+        },
+        {
+            "rel": "orders",
+            "href": "http://localhost:4567/customers/1/orders"
+        },
+        {
+            "rel": "bills",
+            "href": "http://localhost:4567/customers/1/bills"
+        }
+    ]
+}
+

data/spec/sinatra/public/customers/1/provisionings

@@ -0,0 +1 @@
+{"entries":[{"id":"1234567890","parent":"0","service_key":"SERHOST0001","created_at":"2011-09-23","active":true,"status":"active"}]}

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+require 'rspec'
+require 'musashi'
+

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: musashi
+version: !ruby/object:Gem::Version
+  version: 0.0.1.b1
+  prerelease: 6
+platform: ruby
+authors:
+- pahagon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &8196940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8196940
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &8196300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8196300
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &8195460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8195460
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &8194660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *8194660
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &8194040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8194040
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &8193280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8193280
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &8192780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8192780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &8191840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *8191840
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &8188320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *8188320
+description: ! 'Musashi is a library for '
+email: pahagon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- LICENSE
+- README.rdoc
+- ROADMAP.md
+- CHANGELOG.md
+- lib/musashi/resource.rb
+- lib/musashi/connection.rb
+- lib/musashi/retriever.rb
+- lib/musashi/version.rb
+- lib/musashi.rb
+- lib/faraday/response/raise_http_5xx.rb
+- lib/faraday/response/raise_http_4xx.rb
+- spec/spec_helper.rb
+- spec/resource_spec.rb
+- spec/sinatra/public/customers/1.json
+- spec/sinatra/public/customers/1/orders
+- spec/sinatra/public/customers/1/contacts
+- spec/sinatra/public/customers/1/billing_info
+- spec/sinatra/public/customers/1/provisionings
+- spec/sinatra/public/customers/1/bills
+- spec/sinatra/public/customers/1/balance
+- spec/sinatra/public/customers/1/credit_limit
+- spec/sinatra/public/customers/1/billing_contact
+- spec/sinatra/public/customers/1/manager
+- spec/sinatra/app.rb
+homepage: http://github.com/pahagon/musashi
+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: 1.3.6
+requirements: []
+rubyforge_project: musashi
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Musashi is a library for
+test_files:
+- spec/spec_helper.rb
+- spec/resource_spec.rb
+- spec/sinatra/public/customers/1.json
+- spec/sinatra/public/customers/1/orders
+- spec/sinatra/public/customers/1/contacts
+- spec/sinatra/public/customers/1/billing_info
+- spec/sinatra/public/customers/1/provisionings
+- spec/sinatra/public/customers/1/bills
+- spec/sinatra/public/customers/1/balance
+- spec/sinatra/public/customers/1/credit_limit
+- spec/sinatra/public/customers/1/billing_contact
+- spec/sinatra/public/customers/1/manager
+- spec/sinatra/app.rb