url 0.2.2 → 0.3.0

data/lib/url.rb

@@ -3,11 +3,15 @@ require "net/https"
 require 'uri'
 require 'cgi'
 require 'forwardable'
+require "delegate"
 
-
-files = Dir.glob(File.join(File.dirname(__FILE__),'url','*.rb'))
-files.delete_if {|f| f =~ /url\/(classer)\.rb/}
-files.each { |f| require f }
+files = %w{
+  version
+  helper_classes
+  handlers
+  response
+}
+files.each { |f| require File.join(File.dirname(__FILE__),'url',f) }
 
 # Main class for managing urls
 #   url = URL.new('https://mail.google.com/mail/?shva=1#mbox')
@@ -29,6 +33,14 @@ class URL
   # The params for the request
   # @returns [URL::ParamsHash]
   attr_reader :params
+
+  # Set the params for the request
+  # Allows for url.params |= {:foo => 'bar'}
+  # @returns [URL::ParamsHash]
+  def params= p
+    raise ArgumentError, 'Params must be a URL::ParamsHash' unless p.is_a?(ParamsHash)
+    @params = p
+  end
   
   # Attributes of the URL which are editable
   # @returns [String]
@@ -46,6 +58,15 @@ class URL
     
     @path = str
   end
+
+  def add_to_path val
+    unless @path[-1] == 47 # '/'
+      @path << '/'
+    end
+
+    @path << val.sub(/^\//,'')
+    @path
+  end
   
   # Returns array of subdomains
   # @returns [URL::Subdomain]
@@ -107,6 +128,11 @@ class URL
   def host
     [@subdomain,@domain].flatten.compact.join('.')
   end
+
+  # Messed up host/hostname issue :(
+  def host_with_port
+    host<<':'<<port.to_s
+  end
   
   # Outputs the full current url
   # @param [Hash] ops Prevent certain parts of the object from being shown by setting `:scheme`,`:port`,`:path`,`:params`, or `:hash` to `false`
@@ -189,6 +215,12 @@ class URL
   def delete(*args)
     req_handler.delete(*args)
   end
+
+  # Performs a put request for the current URL
+  # @return [URL::Response] A subclass of string which also repsonds to a few added mthods storing more information
+  def put(*args)
+    req_handler.delete(*args)
+  end
   
   def inspect
     "#<#{self.class} #{to_s}>"

data/lib/url/accepts_endpoint.rb

@@ -0,0 +1,39 @@
+class URL
+  class Service
+    module AcceptsEndpoint
+
+      # creates the endpoint for which ever object it's imported into
+      def endpoint arg, &blk
+        endpoint = if arg.is_a?(Hash)
+          f = arg.first
+          name = f.shift
+          f.shift
+        else
+          name = arg
+        end
+
+        eigenclass.send :attr_reader, "#{name}_endpoint"
+        instance_eval <<-RUBY, __FILE__, __LINE__
+          def #{name} params=nil, args={}
+            if params.nil?
+              @#{name}_endpoint
+            else
+              @#{name}_endpoint.find(params,args)
+            end
+          end
+        RUBY
+
+        builder = EndpointBuilder.new(@base_url,endpoint,&blk)
+        e = builder._endpoint
+        
+        e.inflate_into ||= @inflate_into if @inflate_into
+        instance_variable_set "@#{name}_endpoint",e
+      end
+
+      # allows access to the eigenclass
+      def eigenclass
+        class << self; self; end
+      end
+    end
+  end
+end

data/lib/url/endpoint.rb

@@ -0,0 +1,88 @@
+class URL
+  class Service
+    class Endpoint
+      attr_accessor :inflate_into
+      include AcceptsEndpoint
+
+      # Storage for what each endpoint should inflate into
+      def method_inflate_into
+        @method_inflate_into ||= {}
+      end
+
+      # Define the built in methods and their fetcher aliases
+      BUILT_IN_MAP = {
+        :get => %w{find},
+        :post => %w{create},
+        :put => %w{update},
+        :delete => %w{destroy}
+      }.each do |method,aliases|
+        class_eval <<-RUBY, __FILE__, __LINE__
+          def #{method} params = {}, opts = {}
+            u = @url.dup
+            u.params.merge! params
+
+            u.#{method} opts
+          end
+        RUBY
+        aliases.each do |al|
+          class_eval <<-RUBY, __FILE__, __LINE__
+            def #{al} params={}, opts={}
+              transform_response #{method}(params, opts)
+            end
+          RUBY
+        end
+      end.freeze
+
+      BUILT_IN_METHODS = BUILT_IN_MAP.collect do |k,v|
+        v.collect{|vv| vv.to_sym}+[k.to_sym]
+      end.flatten.freeze
+
+      def initialize url
+        @base_url = @url = url
+      end
+
+      # Expose class eval externally
+      def class_eval *args,&blk
+        eigenclass.class_eval *args,&blk
+      end
+
+      def eigenclass
+        class << self; self; end
+      end
+
+      def inspect
+        %Q{#<#{self.class} #{@url.to_s}>}
+      end
+
+    private
+      
+      def transform_response resp, into=nil
+        if resp.connection_refused
+          raise EndpointNotResponding, resp.url_obj.host_with_port
+        end
+
+        if resp && !resp.empty?
+          begin
+            resp = resp.json
+          rescue Exception => e
+            warn "The response #{resp} couldn't be parsed"
+            raise e
+          end
+        end
+        
+        if into ||= inflate_into && resp.is_a?(Hash)
+          into.call(resp)
+        else
+          resp
+        end
+      end
+
+      class << self
+        
+      end
+
+      class RequiredParameter < RuntimeError; end
+      class EndpointNotResponding < Errno::ECONNREFUSED; end
+    end
+  end
+end

data/lib/url/endpoint_builder.rb

@@ -0,0 +1,78 @@
+class URL
+  class Service
+    class EndpointBuilder
+      attr_reader :_endpoint
+      extend Forwardable
+
+      # Create a method missing enironment to build out all the methods on the
+      # endpoint object
+      def initialize base_url, endpoint, params={}, &blk
+        @url = base_url.dup
+        @url.add_to_path endpoint.to_s
+        @url.params.merge!(params)
+        @_endpoint = Endpoint.new(@url)
+        
+        instance_eval &blk if block_given?
+      end
+
+      # Allow nesting of endpoints
+      def_delegators :@_endpoint, :endpoint
+
+      def returns arg=nil, &blk
+        blk = arg unless block_given?
+        @_endpoint.inflate_into = blk
+      end
+
+      # Build any additional methods sent
+      def method_missing *args, &blk
+        if m = caller.first.match(/^(#{__FILE__}:\d+):in `method_missing'$/) # protect against a typo within this function creating a stack overflow
+          raise "Method missing calling itself with #{args.first} in #{m[1]}"
+        end
+        is_built_in = false
+        # If you define a method named get,post,create,etc don't require the method type
+        if Endpoint::BUILT_IN_METHODS.include?(args.first) && !Endpoint::BUILT_IN_METHODS.include?(args[1])
+          name = args.shift
+
+          if Endpoint::BUILT_IN_MAP.has_key?(name.to_sym)
+            method = name.to_sym
+            is_built_in = true
+          else
+            method = Endpoint::BULT_IN_MAP.find do |meth,aliases|
+              aliases.include?(name)
+            end
+
+            method = method[0] if method
+          end
+        else
+          name = args.shift
+          method = args.shift if args.first.is_a?(Symbol)
+        end
+        name = name.to_sym
+
+        method ||= :get
+        
+        options = args.shift||{}
+        options[:requires] ||= []
+        options[:requires] = [options[:requires]] unless options[:requires].is_a?(Array)
+        options[:into] ||= blk if block_given?
+        @_endpoint.method_inflate_into[name] = options[:into]
+
+        @_endpoint.class_eval <<-RUBY, __FILE__, __LINE__
+          def #{name} force_params={}, args={}
+            params = #{(options[:default]||{}).inspect}.merge(force_params)
+            #{(options[:requires]||[]).inspect}.each do |req|
+              raise RequiredParameter, "#{name} endpoint requires the "<<req<<" paramerter" unless params.include?(req.to_sym) || params.include?(req.to_s)
+            end
+
+            if #{is_built_in.inspect}
+              super(params,args)
+            else
+              transform_response(#{method}(params,args),method_inflate_into[#{name.inspect}])
+            end
+          end
+        RUBY
+      end
+
+    end
+  end
+end

data/lib/url/handlers.rb

@@ -30,6 +30,10 @@ class URL
     def delete(args={})
       raise Exception, "You need to implement #{self.class}#delete"
     end
+
+    def put(args={})
+      raise Exception, "You need to implement #{self.class}#put"
+    end
   end
   
   class JSONHandler

data/lib/url/handlers/net_handler.rb

@@ -7,6 +7,8 @@ class URL
       t = Time.now
       resp = http.request(request)
       make_str(resp,Time.now-t)
+    rescue Errno::ECONNREFUSED => e
+      make_error
     end
     
     def post(args={})
@@ -16,6 +18,8 @@ class URL
       t = Time.now
       resp = http.request(request)
       make_str(resp,Time.now-t)
+    rescue Errno::ECONNREFUSED => e
+      make_error
     end
     
     def delete(args={})
@@ -24,6 +28,19 @@ class URL
       t = Time.now
       resp = http.request(request)
       make_str(resp,Time.now-t)
+    rescue Errno::ECONNREFUSED => e
+      make_error
+    end
+
+    def put(args={})
+      http = http_obj
+      request = Net::HTTP::Put.new(make_path)
+      request.body = url.params.to_s(false)
+      t = Time.now
+      resp = http.request(request)
+      make_str(resp,Time.now-t)
+    rescue Errno::ECONNREFUSED => e
+      make_error
     end
     
   private
@@ -31,6 +48,17 @@ class URL
     def make_path
       url.path
     end
+
+    def make_error
+      hsh = {
+        :code => 0,
+        :url => url.to_s,
+        :url_obj => url,
+        :connection_refused => true
+      }
+
+      Response.new('',hsh)
+    end
     
     def make_str(resp,time)
       hsh = {
@@ -38,7 +66,8 @@ class URL
         :time => time,
         :body => resp.body,
         :response => resp,
-        :url => url.to_s
+        :url => url.to_s,
+        :url_obj => url
       }
       
       Response.new(hsh)

data/lib/url/handlers/ty_handler.rb

@@ -18,6 +18,16 @@ class URL
       resp = Typhoeus::Request.delete(url.to_s)
       make_str(resp)
     end
+
+    def put(args={})
+      resp = Typhoeus::Request.put(url.to_s, :body => url.params.to_s(false))
+      make_str(resp)
+    end
+
+    def head(args={})
+      resp = Typhoesu::Request.head(url.to_s)
+      make_str(resp)
+    end
     
   private
     
@@ -27,7 +37,8 @@ class URL
         :time => resp.time,
         :body => resp.body,
         :response => resp,
-        :url => url.to_s
+        :url => url.to_s,
+        :url_obj => url
       }
       
       Response.new(hsh)

data/lib/url/helper_classes.rb

@@ -16,11 +16,23 @@ class URL
   end
   
   class ParamsHash < Mash
-    
+    def | other
+      unless other.is_a? ParamsHash
+        other = other.to_hash if other.respond_to?(:to_hash)
+        other = ParamsHash[other]
+      end
+      other.merge(self)
+    end
+
+    def reverse_merge! other
+      replace self|other
+    end
+
     # Merges the array into a parameter string of the form <tt>?key=value&foo=bar</tt>
-    def to_s
+    def to_s(questionmark=true)
       return '' if empty?
-      '?' + to_a.inject(Array.new) do |ret,param|
+      str = questionmark ? '?' : ''
+      str << to_a.inject(Array.new) do |ret,param|
         key = param[0].to_s
         val = param[1]
         
@@ -50,6 +62,7 @@ class URL
         end
         ret
       end.join('&')
+      str
     end
     
     class << self

data/lib/url/response.rb

@@ -1,5 +1,3 @@
-require "delegate"
-
 class URL
   
   # The Response class is a deleegate to string which also contains metadata about the request.
@@ -26,6 +24,16 @@ class URL
     # The url which generated this response
     # @returns [String]
     attr_reader :url
+
+    # The url object used to create the response
+    # @returns [URL]
+    attr_reader :url_obj
+
+    # This is set to true if the target server was not reachable
+    # @returns [Boolean]
+    def connection_refused
+      @connection_refused || code == 0
+    end
     
     # @param [String] body The body of the response object, main string
     # @param [Hash] args Additional arguments: :time,:code,:response,:url
@@ -35,7 +43,7 @@ class URL
         str = args[:body]
       end
       
-      raise unless str
+      raise ArgumentError, "No string provided" unless str
       super(str)
       args.each do |key, value|
         instance_variable_set "@#{key}", value

data/lib/url/service.rb

@@ -0,0 +1,54 @@
+%w{
+  accepts_endpoint
+  endpoint
+  endpoint_builder
+}.each { |f| require File.join(File.dirname(__FILE__),f) }
+
+class URL::Service
+  INHERITED_INSTANCE_VARIABLES = {:@base_url=>:dup}
+  extend AcceptsEndpoint
+  class << self
+    attr_accessor :config
+    def set_url url
+      unless url.is_a?(URL)
+        url = URL.new(url)
+      end
+      @base_url = url
+      self
+    end
+
+    def inherited(subclass)
+      super
+
+
+      if defined?(Rails) && File.exist?(Rails.root+'config/services.yml')
+        self.config ||= YAML.load_file(Rails.root+'config/services.yml')[Rails.env] rescue nil
+
+        if config
+          target_name = subclass.to_s.demodulize.underscore
+          service_url = config[target_name]||config[target_name.sub(/_service$/,'')]
+        end
+      end
+
+      if service_url
+        subclass.set_url service_url
+      end
+
+      ivs = subclass.instance_variables.collect{|x| x.to_s}
+      INHERITED_INSTANCE_VARIABLES.each do |iv,dup|
+        next if ivs.include?(iv.to_s)
+        sup_class_value = instance_variable_get(iv)
+        sup_class_value = sup_class_value.dup if dup == :dup && sup_class_value
+        subclass.instance_variable_set(iv, sup_class_value)
+      end
+    end
+
+  end
+
+end
+
+class << URL
+  def Service url
+    Class.new(URL::Service).set_url(url)
+  end
+end

data/lib/url/version.rb

@@ -1,3 +1,3 @@
 class URL
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/handler_spec.rb

@@ -1,6 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 shared_examples_for "all requests" do
+  before do
+    @resp = @url.send(@method)
+  end
   it "should work" do
     @resp.should be_success
   end
@@ -14,6 +17,19 @@ shared_examples_for "all requests" do
     @resp.code.should be_a(Integer)
     @resp.url.should be_a(String)
   end
+
+  it "should not error when making request" do
+    test_connection_issue(@method)
+  end
+
+end
+
+def test_connection_issue(sym)
+  u = URL.new('http://localhost:5280')
+  resp = nil
+  expect {resp = u.send(sym)}.to_not raise_error
+  resp.should_not be_successful
+  resp.connection_refused.should be true
 end
 
 shared_examples_for "all builds" do
@@ -25,21 +41,22 @@ shared_examples_for "all builds" do
   
   describe "#get" do
     before do
-      @resp = @url.get
+      @method = :get
     end
+
     it_should_behave_like "all requests"
   end
   
   describe "#post" do
     before do
-      @resp = @url.post
+      @method = :post
     end
     it_should_behave_like "all requests"
   end
   
   describe "#delete" do
     before do
-      @resp = @url.delete
+      @method = :delete
     end
     it_should_behave_like "all requests"
   end

data/spec/service_spec.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Tal Atlas
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 -04:00
-default_executable: 
+date: 2011-07-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -58,7 +57,10 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- lib/url/accepts_endpoint.rb
 - lib/url/classer.rb
+- lib/url/endpoint.rb
+- lib/url/endpoint_builder.rb
 - lib/url/handlers/as_json_handler.rb
 - lib/url/handlers/base_json_handler.rb
 - lib/url/handlers/net_handler.rb
@@ -67,18 +69,19 @@ files:
 - lib/url/handlers.rb
 - lib/url/helper_classes.rb
 - lib/url/response.rb
+- lib/url/service.rb
 - lib/url/version.rb
 - lib/url.rb
 - LICENSE
 - spec/classer_spec.rb
 - spec/handler_spec.rb
 - spec/json_spec.rb
+- spec/service_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/url_spec.rb
 - README.rdoc
 - Rakefile
-has_rdoc: true
 homepage: http://github.com/talby/url
 licenses: []
 
@@ -108,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: A URL object