remote_api 0.1.0 → 0.1.2

data/Manifest.txt

@@ -5,9 +5,7 @@ README.txt
 Rakefile
 setup.rb
 
-lib/dsl_accessor.rb
 lib/remote_api.rb
-
 lib/remote_api/base.rb
 lib/remote_api/xml.rb
 lib/remote_api/xml_response.rb

data/README.txt

@@ -1,3 +1,41 @@
-README for remote_api
-=====================
+Simple Readme for now.
 
+Rubyforge Project: http://rubyforge.org/projects/remote-api/
+
+=== Installation
+
+  gem install remote_api
+
+=== Example
+
+This is an example of how to access a little API that allows you to change the title of an object.
+The API would return the title, but in Title Case, and we want to capture that.
+  
+  require 'remote_api'
+  
+  class MyAPI < RemoteAPI
+    
+    attr_reader :title
+    
+    url 'http://test.com/posts/change_title'
+    
+    def request
+      "title=#{@title}&post_id={@post_id}"
+    end
+    
+    def assert_success
+      if @response =~ /&?error=(.+?)&?/
+        raise ResponseFailure, $1
+      end
+    end
+    
+    def process
+      @title = @response.match(/&?title=(.+?)&?/)[1]
+    end
+    
+  end
+  
+  result = MyAPI.new(:post_id => 123, :title => 'hello world')
+  # API call happens here
+  
+  result.title #=> 'Hello World'

data/Rakefile

@@ -44,6 +44,6 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   #p.changes        - A description of the release's latest changes.
-  p.extra_deps = %w( activesupport )
+  p.extra_deps = [['activesupport'], ['dsl_accessor']]
   #p.spec_extras    - A hash of extra values to set in the gemspec.
 end

data/lib/remote_api/base.rb

@@ -1,7 +1,8 @@
 class RemoteAPI
   class ResponseFailure < RuntimeError; end
   
-  dsl_accessor :debug
+  dsl_accessor :debug
+  dsl_accessor :log_file
   dsl_accessor :url
   dsl_accessor :content_type
   
@@ -57,12 +58,12 @@ class RemoteAPI
       true
     end
     
-    def process(*args)
+    def process
       raise 'You must define a "process" method!  This should should parse the @response and' + 
             'extract relevant data.'
     end
     
-    def request(*args)
+    def request
       raise 'You must define a "request" method!  This should create the body of your API request'
     end
     
@@ -88,33 +89,45 @@ class RemoteAPI
     def format_response(response)
       response
     end
+    
+    def log(data)
+      data = "\n\n\n\n\n*** #{Time.now}\n\n" + data
+      if file = self.class.log_file
+        File.open(file, 'a') { |f| f.write data }
+      end
+    end
     
     def debug_request(request_body)
-      return unless self.class.debug
-      puts <<DEBUG
+      return unless self.class.debug || self.class.log_file
+      text = <<DEBUG
 
 -----------
 - REQUEST -
 -----------
 
 #{request_body}
-DEBUG
+DEBUG
+      puts text if self.class.debug
+      log(text) if self.class.log_file
     end
     
     def debug_response(response, url)
-      return unless self.class.debug
+      return unless self.class.debug || self.class.log_file
       
-      parsed_response = format_response(response)
+      text = format_response(response)
       
-      puts <<DEBUG
+      text = <<DEBUG
 
 ------------"
 - RESPONSE -"
 ------------"
 --- From: #{url}" 
 
-#{parsed_response}
+#{text}
 
-DEBUG
+DEBUG
+
+     puts text if self.class.debug
+     log(text) if self.class.log_file
     end
 end

data/lib/remote_api/version.rb

@@ -2,7 +2,7 @@ class RemoteAPI #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/remote_api.rb

@@ -1,13 +1,13 @@
+# Standard Libraries
 require 'net/https'
 require 'rexml/document'
 require 'uri'
 
+# Gems
 require 'active_support'
+require 'dsl_accessor'
 
-# Why isn't this a gem?
-require File.join(File.dirname(__FILE__), 'dsl_accessor')
-
-# remote_api files
+# remote_api
 require 'remote_api/base'
 require 'remote_api/xml'
 require 'remote_api/xml_response'

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.1
 specification_version: 1
 name: remote_api
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-01-15 00:00:00 -08:00
+  version: 0.1.2
+date: 2007-01-17 00:00:00 -08:00
 summary: Provides a basic framework for easily creating classes that access remote APIs.
 require_paths: 
 - lib
@@ -34,7 +34,6 @@ files:
 - README.txt
 - Rakefile
 - setup.rb
-- lib/dsl_accessor.rb
 - lib/remote_api.rb
 - lib/remote_api/base.rb
 - lib/remote_api/xml.rb
@@ -68,3 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: dsl_accessor
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: 

data/lib/dsl_accessor.rb

@@ -1,50 +0,0 @@
-class Class
-  def dsl_accessor(name, options = {})
-    raise TypeError, "DSL Error: options should be a hash. but got `#{options.class}'" unless options.is_a?(Hash)
-    writer = options[:writer] || options[:setter]
-    writer =
-      case writer
-      when NilClass then Proc.new{|value| value}
-      when Symbol   then Proc.new{|value| __send__(writer, value)}
-      when Proc     then writer
-      else raise TypeError, "DSL Error: writer should be a symbol or proc. but got `#{options[:writer].class}'"
-      end
-    write_inheritable_attribute(:"#{name}_writer", writer)
-
-    default =
-      case options[:default]
-      when NilClass then nil
-      when []       then Proc.new{[]}
-      when {}       then Proc.new{{}}
-      when Symbol   then Proc.new{__send__(options[:default])}
-      when Proc     then options[:default]
-      else Proc.new{options[:default]}
-      end
-    write_inheritable_attribute(:"#{name}_default", default)
-
-    self.class.class_eval do
-      define_method("#{name}=") do |value|
-        writer = read_inheritable_attribute(:"#{name}_writer")
-        value  = writer.call(value) if writer
-        write_inheritable_attribute(:"#{name}", value)
-      end
-
-      define_method(name) do |*values|
-        if values.empty?
-          # getter method
-          key = :"#{name}"
-          if !inheritable_attributes.has_key?(key)
-            default = read_inheritable_attribute(:"#{name}_default")
-            value   = default ? default.call(self) : nil
-            __send__("#{name}=", value)
-          end
-          read_inheritable_attribute(key)
-        else
-          # setter method
-          __send__("#{name}=", *values)
-        end
-      end
-    end
-  end
-end
-