capacity 0.0.1 → 0.0.2

data/Manifest

@@ -1,3 +1,5 @@
+Manifest
 Rakefile
 lib/capacity.rb
-Manifest
+lib/capacity/api.rb
+lib/capacity/response.rb

data/Rakefile

@@ -2,8 +2,9 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('capacity', '0.0.1') do |p|
-  p.description = 'A handy class for interacting with the Capacity API'
+Echoe.new('capacity', '0.0.2') do |p|
+  p.summary = "Driver for the Capacity API"
+  p.description = 'Not even alpha, not for production use, and not much use to anyone but us at the moment!'
   p.url = 'http://getcapacity.com/'
   p.author = 'Peat Bakke'
   p.email = 'peat@getcapacity.com'

data/capacity.gemspec

@@ -2,23 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capacity}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peat Bakke"]
   s.cert_chain = ["/Users/peat/.ssh/gem-public_cert.pem"]
   s.date = %q{2010-10-20}
-  s.description = %q{A handy class for interacting with the Capacity API}
+  s.description = %q{Not even alpha, not for production use, and not much use to anyone but us at the moment!}
   s.email = %q{peat@getcapacity.com}
-  s.extra_rdoc_files = ["lib/capacity.rb"]
-  s.files = ["Rakefile", "lib/capacity.rb", "Manifest", "capacity.gemspec"]
+  s.extra_rdoc_files = ["lib/capacity.rb", "lib/capacity/api.rb", "lib/capacity/response.rb"]
+  s.files = ["Manifest", "Rakefile", "lib/capacity.rb", "lib/capacity/api.rb", "lib/capacity/response.rb", "capacity.gemspec"]
   s.homepage = %q{http://getcapacity.com/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Capacity"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{capacity}
   s.rubygems_version = %q{1.3.7}
   s.signing_key = %q{/Users/peat/.ssh/gem-private_key.pem}
-  s.summary = %q{A handy class for interacting with the Capacity API}
+  s.summary = %q{Driver for the Capacity API}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/capacity.rb

@@ -1,75 +1,18 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+# general requirements
 require 'rubygems'
 require 'uri'
 require 'net/http'
 require 'json'
 
-# talks with the Capcity API
-class Capacity
+# local requirements
+require 'capacity/response'
+require 'capacity/api'
+
+module Capacity
   
   SERVER = 'http://localhost:8080/'
   VERSION = 'v1'
-
-  @@token = nil
-
-  def self.token=( token )
-    @@token = token
-  end
-
-  def self.get( resource, query = {} )
-    request( :get, resource, query )
-  end
-
-  def self.post( resource, query = {} )
-    request( :post, resource, query )
-  end
-
-  def self.put( resource, query = {} )
-    request( :put, resource, query )
-  end
-  
-  def self.delete( resource, query = {} )
-    request( :delete, resource, query )
-  end
-  
-  protected
-  
-  def self.request( http_method, resource, query = {} )
-    query.merge!( { :token => @@token } ) if @@token
-    
-    url = URI.parse("#{SERVER}#{VERSION}/#{resource}")
-
-    # hack for query parameter in GETs
-    if http_method == :get
-      if query.empty?
-        get_path = url.path
-      else
-        query_array = []
-        query.each do |k,v|
-          if v.is_a?(Hash) # sub-key/value pairs, eg: query[foo]=abcdef query[bar]=zed
-            v.each do |subKey, subVal|
-              query_array << URI.escape( "#{k.to_s}[" + subKey.to_s + "]" ) + "=" + URI.escape( subVal.to_s )
-            end
-          else
-            query_array << "#{URI.escape( k.to_s )}=#{URI.escape( v.to_s )}"
-          end
-        end
-        get_path = url.path + "?" + query_array.join("&");
-      end
-    end
-
-    req = case http_method
-      when :get then Net::HTTP::Get.new( get_path )
-      when :put then Net::HTTP::Put.new( url.path )
-      when :post then Net::HTTP::Post.new( url.path )
-      when :delete then Net::HTTP::Delete.new( url.path )
-    end
-
-    res = Net::HTTP.start( url.host, url.port ) { |http|
-      req.set_form_data( query ) if http_method != :get
-      http.request( req )
-    }
-
-    JSON.parse( res.body )
-  end
   
 end

data/lib/capacity/api.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'uri'
+require 'net/http'
+require 'json'
+
+# talks with the Capcity API
+module Capacity
+
+  class API
+  
+    attr_accessor :token
+
+    def get( resource, query = {} )
+      request( :get, resource, query )
+    end
+
+    def post( resource, query = {} )
+      request( :post, resource, query )
+    end
+
+    def put( resource, query = {} )
+      request( :put, resource, query )
+    end
+  
+    def delete( resource, query = {} )
+      request( :delete, resource, query )
+    end
+  
+    protected
+  
+    def request( http_method, resource, query = {} )
+      query.merge!( { :token => token } ) if token
+    
+      url = URI.parse("#{Capacity::SERVER}#{Capacity::VERSION}/#{resource}")
+
+      # hack for query parameter in GETs
+      if http_method == :get
+        if query.empty?
+          get_path = url.path
+        else
+          query_array = []
+          query.each do |k,v|
+            if v.is_a?(Hash) # sub-key/value pairs, eg: query[foo]=abcdef query[bar]=zed
+              v.each do |subKey, subVal|
+                query_array << URI.escape( "#{k.to_s}[" + subKey.to_s + "]" ) + "=" + URI.escape( subVal.to_s )
+              end
+            else
+              query_array << "#{URI.escape( k.to_s )}=#{URI.escape( v.to_s )}"
+            end
+          end
+          get_path = url.path + "?" + query_array.join("&");
+        end
+      end
+
+      req = case http_method
+        when :get then Net::HTTP::Get.new( get_path )
+        when :put then Net::HTTP::Put.new( url.path )
+        when :post then Net::HTTP::Post.new( url.path )
+        when :delete then Net::HTTP::Delete.new( url.path )
+      end
+
+      res = Net::HTTP.start( url.host, url.port ) { |http|
+        req.set_form_data( query ) if http_method != :get
+        http.request( req )
+      }
+
+      Response.new( JSON.parse( res.body ) )
+    end
+  
+  end
+  
+end

data/lib/capacity/response.rb

@@ -0,0 +1,50 @@
+module Capacity
+  class Response
+
+    include Enumerable
+
+    # Expects 'resp' to be a hash, created from the API's JSON response
+    def initialize( resp )
+      # setup the local key/value store
+      @data = {}
+      
+      if resp['status'] != 'OK'
+        # see if there's an error
+        @error = resp['error']
+      else
+        @error = nil
+        # find the embedded hash that will contain the response data
+        resp.each do |k,v|
+          if v.is_a?( Hash ) # there it is!
+            v.each { |kp,vp| @data[kp.to_sym] = vp } # symbolize keys
+            break # stop searching
+          end
+        end
+      end
+    end
+    
+    # returns boolean for whether or not there was an error
+    def error?
+      !@error.to_s.empty?
+    end
+    
+    # returns the error message
+    def error
+      @error
+    end
+    
+    # satisfies Enumerable requirements
+    def each
+      @data.each do |k,v|
+        yield k,v
+      end
+    end
+    
+    # provides string/symbol agnostic, hash-like accessor
+    def []( key )
+      @data[ key.to_sym ]
+    end
+
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Peat Bakke
@@ -39,7 +39,7 @@ date: 2010-10-20 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: A handy class for interacting with the Capacity API
+description: Not even alpha, not for production use, and not much use to anyone but us at the moment!
 email: peat@getcapacity.com
 executables: []
 
@@ -47,10 +47,14 @@ extensions: []
 
 extra_rdoc_files: 
 - lib/capacity.rb
+- lib/capacity/api.rb
+- lib/capacity/response.rb
 files: 
+- Manifest
 - Rakefile
 - lib/capacity.rb
-- Manifest
+- lib/capacity/api.rb
+- lib/capacity/response.rb
 - capacity.gemspec
 has_rdoc: true
 homepage: http://getcapacity.com/
@@ -87,6 +91,6 @@ rubyforge_project: capacity
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A handy class for interacting with the Capacity API
+summary: Driver for the Capacity API
 test_files: []