divoxx-patronage 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,13 +1,35 @@
-= patronage
+= Patronage
 
-Description goes here.
+Patronage is a small and generic library for accessing and interacting with web-services. It is 
+built on top of another Ruby library named Patron, which uses libcurl.
+
+== Usage Example
+
+Supposing there's an API in the address http://example.com/api and you want to perform a query to
+/users.xml.
+
+	# Creates an API instance with a default parameter that should be sent in all requests
+	api = Patronage::API.new("http://example.com/api", :params => {:token => "79173109187231827312"})
+	
+	# Will perform a GET request to http://example.com/api/users.xml?token=79173109187231827312&id=1
+	resp = api.service(:users, :format => 'xml').get(:id => "1")
+	
+	# To access the response, already parsed.
+	resp.payload
+	
+	# To access the raw response
+	resp.body
+	
+	# Get the response status code
+	resp.status
 
 == Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull).
+* Commit, do not mess with rakefile, version, or history (if you want to have your own version, 
+	that is fine but bump version in a commit by itself I can ignore when I pull).
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/patronage/api.rb

@@ -18,8 +18,8 @@ module Patronage
       @session.get(url.to_s, headers)
     end
   
-    def service(service_name)
-      Service.new(self, service_name)
+    def service(service_name, opts = {})
+      Service.new(self, service_name, opts)
     end
   end
 end

data/lib/patronage/service.rb

@@ -2,13 +2,16 @@ module Patronage
   class Service
     attr_reader :name
   
-    def initialize(api, name)
+    def initialize(api, name, opts = {})
       @api  = api
       @name = name.to_s
+      @opts = opts
     end
   
     def service_location
-      "/#{name}"
+      location = "/#{name}"
+      location << ".#{@opts[:format]}" if @opts[:format]
+      location
     end
   
     def get(params)

data/patronage.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{patronage}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rodrigo Kochenburger"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: divoxx-patronage
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Rodrigo Kochenburger