remotely 0.1.1 → 0.1.2

data/README.md

@@ -3,11 +3,16 @@
 Remotely lets you specify associations for your models that should
 be fetched from a remote API instead of the database.
 
-## App Setup
+## Configuration
 
 Apps are where Remotely goes to find association resources. You can define as many as you want, but if you define only one, you can omit the `:app` option from your associations.
 
-    Remotely.app :legsapp, "http://omgsomanylegs.com/api/v1"
+    Remotely.configure do
+      app :legsapp do
+        url "http://somanylegs.com/api/v1"
+        basic_auth "username", "password"
+      end
+    end
 
 ## Defining Associations
 
@@ -37,6 +42,23 @@ Apps are where Remotely goes to find association resources. You can define as ma
       has_many_remote :legs, :app => :legsapp, ...
     end
 
+**Note about associations**
+
+If you do not specify the `:app` options in your associations, you need
+to create a `Remotely::Model` subclass for the associated object. This
+is so Remotely knows which app to use to retrieve entries of that type.
+
+    class Person < ActiveRecord::Base
+      has_many_remote :legs
+    end
+
+    # Means the following must exist:
+
+    class Leg < Remotely::Model
+      app :legsapp
+      uri "/legs"
+    end
+
 ### id Substitution
 
 A path can include "`:id`" anywhere in it, which is replaced by the instance's `id`. This is useful when the resource on the API end is namespaced. For example:

data/lib/remotely.rb

@@ -4,14 +4,15 @@ require "active_support/inflector"
 require "active_support/concern"
 require "active_support/core_ext/hash"
 require "active_model"
+
 require "remotely/ext/url"
+require "remotely/application"
+require "remotely/http_methods"
+require "remotely/associations"
+require "remotely/model"
+require "remotely/collection"
 
 module Remotely
-  autoload :Collection,   "remotely/collection"
-  autoload :Associations, "remotely/associations"
-  autoload :Model,        "remotely/model"
-  autoload :HTTPMethods,  "remotely/http_methods"
-
   class RemotelyError < StandardError
     def message; self.class::MESSAGE; end
   end
@@ -38,7 +39,7 @@ module Remotely
   end
 
   class << self
-    # @return [Hash] Hash of registered apps (key: name, value: URL)
+    # @return [Hash] Registered application configurations
     def apps
       @apps ||= {}
     end
@@ -61,27 +62,20 @@ module Remotely
     #
     # @param [Symbol] name Placeholder name for the application.
     # @param [String] url URL to the application's API.
+    # @param [Block]  Block defining the attributes of the application.
     #
-    def app(name, url)
-      url  = URI.parse(url)
-      apps[name] = { base: "#{url.scheme || "http"}://#{url.host}:#{url.port}", uri: url.path }
-    end
-
-    # Set the Basic Auth user and password to use when making
-    # requests.
-    #
-    # @param [String] user BasicAuth user
-    # @param [String] password BasicAuth password
-    #
-    def basic_auth(user=nil, password=nil)
-      user and password and @basic_auth = [user, password] or @basic_auth
+    def app(name, url=nil, &block)
+      if !url && block_given?
+        apps[name] = Application.new(name, &block)
+      else
+        apps[name] = Application.new(name) { url(url) }
+      end
     end
 
     # Clear all registered apps
     #
     def reset!
       @apps = {}
-      @basic_auth = nil
     end
   end
 end

data/lib/remotely/application.rb

@@ -0,0 +1,49 @@
+module Remotely
+  class Application
+    attr_reader :name
+
+    def initialize(name, &block)
+      @name = name
+      instance_eval(&block)
+    end
+
+    # Set or get the applications base url.
+    #
+    # @param [String] url Base url to the appplication
+    #
+    def url(url=nil)
+      return @url unless url
+      @url = URI.parse(set_scheme(url)).to_s
+    end
+
+    # Set or get BasicAuth credentials.
+    #
+    # @param [String] user BasicAuth user
+    # @param [String] password BasicAuth password
+    #
+    def basic_auth(user=nil, password=nil)
+      return @basic_auth unless user && password
+      @basic_auth = [user, password]
+    end
+
+    # Connection to the application (with BasicAuth if it was set).
+    #
+    def connection
+      return unless @url
+
+      @connection ||= Faraday::Connection.new(@url) do |b|
+        b.request :url_encoded
+        b.adapter :net_http
+      end
+
+      @connection.basic_auth(*@basic_auth) if @basic_auth
+      @connection
+    end
+
+  private
+
+    def set_scheme(url)
+      url =~ /^http/ ? url : "http://#{url}"
+    end
+  end
+end

data/lib/remotely/associations.rb

@@ -193,7 +193,7 @@ module Remotely
     end
 
   private
-  
+
     def can_fetch_remotely_association?(name)
       opts = remote_associations[name]
 
@@ -218,7 +218,7 @@ module Remotely
     def fetch_association(name)
       type     = remote_associations[name][:type]
       klass    = name.to_s.classify.constantize
-      response = self.class.get(path_to(name, type), :class => klass, :parent => self)
+      response = klass.get(path_to(name, type), :class => klass, :parent => self)
       set_association(name, response)
     end
 

data/lib/remotely/ext/url.rb

@@ -5,6 +5,7 @@ class URL
     @url = "/" + args.flatten.compact.join("/")
     @url.gsub! %r[/{2,}], "/"
     @url.gsub! %r[/$], ""
+    define_delegation_methods
   end
 
   def +(other)
@@ -22,6 +23,20 @@ class URL
   def to_s
     @url
   end
+
+private
+
+  def define_delegation_methods
+    @url.public_methods(false).each do |name|
+      metaclass.class_eval do
+        define_method(name) { |*args| @url.send(name, *args) }
+      end
+    end
+  end
+
+  def metaclass
+    (class << self; self; end)
+  end
 end
 
 def URL(*args)

data/lib/remotely/http_methods.rb

@@ -12,6 +12,10 @@ module Remotely
     # Set or get the app for this model belongs to. If name is passed,
     # it's a setter, otherwise, a getter.
     #
+    # In getter form, if a model didn't declare which app it is
+    # associated with and there is only one registered app, it
+    # will default to that app.
+    #
     # @overload app()
     #   Gets the current `app` value.
     #
@@ -22,11 +26,7 @@ module Remotely
     # @return [Symbol] New app symbol or current value.
     #
     def app(name=nil)
-      if @app.nil? && name.nil? && Remotely.apps.size == 1
-        name = Remotely.apps.first.first
-      end
-
-      (name and @app = name) or @app
+      @app = (@app || Remotely.apps[name] || only_registered_app)
     end
 
     # Set or get the base uri for this model. If name is passed,
@@ -42,24 +42,7 @@ module Remotely
     # @return [String] New uri or current value.
     #
     def uri(path=nil)
-      (path and @uri = path) or @uri
-    end
-
-    # The connection to the remote API.
-    #
-    # @return [Faraday::Connection] Connection to the remote API.
-    #
-    def remotely_connection
-      address = Remotely.apps[app][:base]
-      address = "http://#{address}" unless address =~ /^http/
-
-      @connection ||= Faraday::Connection.new(address) do |b|
-        b.request  :url_encoded
-        b.adapter  :net_http
-      end
-
-      @connection.basic_auth(*Remotely.basic_auth) if Remotely.basic_auth
-      @connection
+      @uri = (@uri || path)
     end
 
     # GET request.
@@ -71,14 +54,14 @@ module Remotely
     #   is an array, Collection, if it's a hash, Model, otherwise it's the
     #   parsed response body.
     #
-    def get(uri, options={})
-      uri      = expand(uri)
+    def get(path, options={})
+      path     = expand(path)
       klass    = options.delete(:class)
       parent   = options.delete(:parent)
 
-      before_request(uri, :get, options)
+      before_request(path, :get, options)
 
-      response = remotely_connection.get { |req| req.url(uri, options) }
+      response = app.connection.get { |req| req.url(path, options) }
       parse_response(raise_if_html(response), klass, parent)
     end
 
@@ -95,14 +78,14 @@ module Remotely
     #   is an array, Collection, if it's a hash, Model, otherwise it's the
     #   parsed response body.
     #
-    def post(uri, options={})
-      uri    = expand(uri)
+    def post(path, options={})
+      path   = expand(path)
       klass  = options.delete(:class)
       parent = options.delete(:parent)
       body   = options.delete(:body) || Yajl::Encoder.encode(options)
 
-      before_request(uri, :post, body)
-      raise_if_html(remotely_connection.post(uri, body))
+      before_request(path, :post, body)
+      raise_if_html(app.connection.post(path, body))
     end
 
     # PUT request.
@@ -113,12 +96,12 @@ module Remotely
     # @return [Boolean] Was the request successful? (Resulted in a
     #   200-299 response code)
     #
-    def put(uri, options={})
-      uri  = expand(uri)
+    def put(path, options={})
+      path = expand(path)
       body = options.delete(:body) || Yajl::Encoder.encode(options)
 
-      before_request(uri, :put, body)
-      raise_if_html(remotely_connection.put(uri, body))
+      before_request(path, :put, body)
+      raise_if_html(app.connection.put(path, body))
     end
 
     # DELETE request.
@@ -128,29 +111,30 @@ module Remotely
     # @return [Boolean] Was the resource deleted? (Resulted in a
     #   200-299 response code)
     #
-    def http_delete(uri)
-      uri = expand(uri)
-      before_request(uri, :delete)
-      response = raise_if_html(remotely_connection.delete(uri))
+    def http_delete(path)
+      path = expand(path)
+      before_request(path, :delete)
+      response = raise_if_html(app.connection.delete(path))
       SUCCESS_STATUSES.include?(response.status)
     end
 
-    # Expand a URI to include any path specified in the the main app
-    # configuration. When creating a Faraday object with a path that
-    # includes a uri, eg: "localhost:1234/api", Faraday drops the path,
-    # making it "localhost:1234". We need to add the "/api" back in
-    # before our relative uri.
+    # Remove the leading slash because Faraday considers
+    # it to be absolute path and ignores any prefixes. eg:
+    #
+    #   c = Faraday::Connection.new("http://foo.com/api")
+    #   c.get("users")  # => /api/users (Good)
+    #   c.get("/users") # => /users     (Bad)
     #
     # @example
     #   Remotely.configure { app :thingapp, "http://example.com/api" }
-    #   Model.expand("/members") # => "/api/members"
+    #   Model.expand("/members") # => "members"
     #
-    def expand(uri)
-      baseuri = Remotely.apps[app][:uri]
-      uri =~ /^#{baseuri}/ ? uri : URL(baseuri, uri)
+    def expand(path)
+      path.gsub(%r(^/), "")
     end
 
     # Gets called before a request. Override to add logging, etc.
+    #
     def before_request(uri, http_verb = :get, options = {})
       if ENV['REMOTELY_DEBUG']
         puts "-> #{http_verb.to_s.upcase} #{uri}" 
@@ -201,5 +185,11 @@ module Remotely
         body
       end
     end
+
+  private
+
+    def only_registered_app
+      Remotely.apps.size == 1 ? Remotely.apps.first.last : nil
+    end
   end
 end

data/lib/remotely/version.rb

@@ -1,3 +1,3 @@
 module Remotely
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/remotely/application_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Remotely::Application do
+  it "sets the url" do
+    app = Remotely::Application.new(:name) { url "http://omg.com" }
+    app.url.should == "http://omg.com"
+  end
+
+  it "defaults the url to http" do
+    app = Remotely::Application.new(:name) { url "omg.com" }
+    app.url.should == "http://omg.com"
+  end
+
+  it "sets basic auth credentials" do
+    app = Remotely::Application.new(:name) { basic_auth "user", "pass" }
+    app.basic_auth.should == ["user", "pass"]
+  end
+
+  it "has a connection to the app" do
+    app = Remotely::Application.new(:name) { url "http://example.com" }
+    app.connection.should be_a Faraday::Connection
+  end
+
+  it "has a connection with basic auth to the app" do
+    app = Remotely::Application.new(:name) do
+      url        "http://example.com"
+      basic_auth "user", "pass"
+    end
+    app.connection.headers["authorization"].should_not be_nil
+  end
+end

data/spec/remotely/model_spec.rb

@@ -257,7 +257,12 @@ describe Remotely::Model do
 
   context "basic auth" do
     before do
-      Remotely.configure { app :adventure_app, "http://localhost:3000" }
+      Remotely.configure do
+        app :adventure_app do
+          url "http://localhost:3000"
+          basic_auth "user", "password"
+        end
+      end
     end
 
     after do
@@ -265,7 +270,6 @@ describe Remotely::Model do
     end
 
     it "sends Authorization headers when basic auth is configured" do
-      Remotely.configure { basic_auth "user", "password" }
       Adventure.find(1)
       a_request(:get, "#{app}/adventures/1").with(headers: {'Authorization' => "Basic dXNlcjpwYXNzd29yZA=="})
     end
@@ -277,7 +281,7 @@ describe Remotely::Model do
   end
 
   it "sets the app it belongs to" do
-    Adventure.app.should == :adventure_app
+    Adventure.app.name.should == :adventure_app
   end
 
   it "sets the uri to itself" do
@@ -285,7 +289,7 @@ describe Remotely::Model do
   end
 
   it "has a connection" do
-    Adventure.remotely_connection.should be_a Faraday::Connection
+    Adventure.app.connection.should be_a Faraday::Connection
   end
 
   it "supports ActiveModel::Naming methods" do
@@ -343,12 +347,8 @@ describe Remotely::Model do
       Thing.app :uri_app
     end
 
-    it "prepends the app uri" do
-      Thing.expand("/members").should == "/api/members"
-    end
-
-    it "doesn't prepend when it's already there" do
-      Thing.expand("/api/members").should == "/api/members"
+    it "removes leading slash to work with Faraday's path_prefix" do
+      Thing.expand("/members").should == "members"
     end
   end
 

data/spec/remotely_spec.rb

@@ -5,19 +5,24 @@ describe Remotely do
     Remotely.reset!
   end
 
-  it "is configurable" do
+  it "is resetable" do
     Remotely.configure { app :configapp, "localhost:2222" }
-    Remotely.apps.should include(:configapp)
+    Remotely.reset!
+    Remotely.apps.should be_empty
   end
 
-  it "configures basic auth parameters" do
-    Remotely.configure { basic_auth "user", "password" }
-    Remotely.basic_auth.should == ["user", "password"]
+  it "is configurable with the old, non-block style" do
+    Remotely.configure { app :configapp, "localhost:2222" }
+    Remotely.apps[:configapp].url.should == "http://localhost:2222"
   end
 
-  it "is resetable" do
-    Remotely.configure { app :configapp, "localhost:2222" }
-    Remotely.reset!
-    Remotely.apps.should be_empty
+  it "is configurable with a block" do
+    Remotely.configure { app(:configapp) { url "localhost:2222" } }
+    Remotely.apps[:configapp].url.should == "http://localhost:2222"
+  end
+
+  it "saves the basic auth credentials" do
+    Remotely.configure { app(:appname) { basic_auth "user", "pass" }}
+    Remotely.apps[:appname].basic_auth.should == ["user", "pass"]
   end
 end

data/spec/support/test_classes.rb

@@ -1,6 +1,8 @@
 require "ostruct"
 
-Remotely.app :adventure_app, "http://localhost:1234"
+Remotely.configure do
+  app :adventure_app, "http://localhost:1234"
+end
 
 class BaseTestClass < OpenStruct
   extend  ActiveModel::Naming

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remotely
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000Z
+date: 2012-01-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2168718920 !ruby/object:Gem::Requirement
+  requirement: &2169407720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168718920
+  version_requirements: *2169407720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168717680 !ruby/object:Gem::Requirement
+  requirement: &2169407000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2168717680
+  version_requirements: *2169407000
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &2168716540 !ruby/object:Gem::Requirement
+  requirement: &2169400760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168716540
+  version_requirements: *2169400760
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &2168716060 !ruby/object:Gem::Requirement
+  requirement: &2169400280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168716060
+  version_requirements: *2169400280
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2168715620 !ruby/object:Gem::Requirement
+  requirement: &2169399780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168715620
+  version_requirements: *2169399780
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2168715040 !ruby/object:Gem::Requirement
+  requirement: &2169399220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168715040
+  version_requirements: *2169399220
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
-  requirement: &2168714480 !ruby/object:Gem::Requirement
+  requirement: &2169398540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168714480
+  version_requirements: *2169398540
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2168714040 !ruby/object:Gem::Requirement
+  requirement: &2169397720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168714040
+  version_requirements: *2169397720
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2168713560 !ruby/object:Gem::Requirement
+  requirement: &2169397260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168713560
+  version_requirements: *2169397260
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2168708460 !ruby/object:Gem::Requirement
+  requirement: &2169396740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168708460
+  version_requirements: *2169396740
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2168708040 !ruby/object:Gem::Requirement
+  requirement: &2169395480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168708040
+  version_requirements: *2169395480
 description: Remote API based model associations.
 email:
 - me@mattenoble.com
@@ -147,6 +147,7 @@ files:
 - README.md
 - Rakefile
 - lib/remotely.rb
+- lib/remotely/application.rb
 - lib/remotely/associations.rb
 - lib/remotely/collection.rb
 - lib/remotely/ext/url.rb
@@ -154,6 +155,7 @@ files:
 - lib/remotely/model.rb
 - lib/remotely/version.rb
 - remotely.gemspec
+- spec/remotely/application_spec.rb
 - spec/remotely/associations_spec.rb
 - spec/remotely/collection_spec.rb
 - spec/remotely/ext/url_spec.rb
@@ -188,6 +190,7 @@ signing_key:
 specification_version: 3
 summary: Remote API based model associations.
 test_files:
+- spec/remotely/application_spec.rb
 - spec/remotely/associations_spec.rb
 - spec/remotely/collection_spec.rb
 - spec/remotely/ext/url_spec.rb