centrum_faktur 0.0.1 → 0.1.0

data/README.markdown

@@ -2,6 +2,12 @@
 
 Ruby client for [Centrum Faktur API](http://centrumfaktur.pl/api/)
 
+## Installation ##
+
+```
+gem install centrum_faktur
+```
+
 ## Configuration ##
 
 ``` ruby
@@ -14,6 +20,133 @@ CentrumFaktur.configure do |config|
 end
 ```
 
+## Usage ##
+
+Requests return Array or Hash, where keys are strings.
+When other format than json (default) or yaml is specified, response is not parsed.
+So for xml and pickle requests string is returned.
+
+``` ruby
+CentrumFaktur::Invoice.show("/api/1.0/invoices/1/", :format => :xml)
+```
+
+All params that respond to `strftime` (i.e. Date, Time) will be normalized to format
+required by API, that is: `"YYYY-MM-DD"`
+
+Writing invoice to pdf can be done as follows:
+
+``` ruby
+File.open("my-invoice.pdf", "w") { |file| file.write(CentrumFaktur::Invoice.show("/api/1.0/invoices/1/", :format => :pdf)) }
+```
+
+### Account ###
+
+Only listing accounts is supported via API
+
+``` ruby
+CentrumFaktur::Account.list
+```
+
+### Comment ###
+
+Listing all comments:
+
+``` ruby
+CentrumFaktur::Comment.list
+```
+
+Or listing comments for given resource:
+
+``` ruby
+CentrumFaktur::Comment.list("/api/1.0/estimates/1/comments/")
+```
+
+Creating comment:
+
+You must pass path to resource comment and required attributes:
+
+``` ruby
+CentrumFaktur::Comment.create("/api/1.0/estimates/1/comments/", {:body => "cool", :is_public => false})
+```
+
+### Estimate ###
+
+Listing all estimates:
+
+``` ruby
+CentrumFaktur::Estimate.list
+```
+
+Monitoring estimate changes (with optional filter param):
+
+``` ruby
+CentrumFaktur::Estimate.list_updates(:updated_since => "2012-01-12")
+```
+
+Creating estimate (check required attributes in API description):
+
+``` ruby
+CentrumFaktur::Estimate.create({})
+```
+
+Updating estimate:
+
+``` ruby
+CentrumFaktur::Estimate.update("/api/1.0/estimates/1/", {})
+```
+
+Removing estimate:
+
+``` ruby
+CentrumFaktur::Estimate.destroy("/api/1.0/estimates/1/")
+```
+
+### Invoice ###
+
+Listing all invoices:
+
+``` ruby
+CentrumFaktur::Invoice.list
+```
+
+Monitoring invoice changes:
+
+``` ruby
+CentrumFaktur::Invoice.list_updates
+```
+
+Displaying invoice:
+
+``` ruby
+CentrumFaktur::Invoice.show("/api/1.0/invoices/1/")
+```
+
+Creating invoice (check required attributes in API description):
+
+``` ruby
+CentrumFaktur::Invoice.create({})
+```
+
+Updating invoice:
+
+``` ruby
+CentrumFaktur::Invoice.update("/api/1.0/invoices/1/", {})
+```
+
+Removing invoice:
+
+``` ruby
+CentrumFaktur::Invoice.destroy("/api/1.0/invoices/1/")
+```
+
+### User ###
+
+Only listing users is supported via API
+
+``` ruby
+CentrumFaktur::User.list
+```
+
 ## Copyright ##
 
 Created during development for [Ragnarson](http://ragnarson.com/)

data/lib/centrum_faktur/comment.rb

@@ -1,11 +1,11 @@
 class CentrumFaktur::Comment
-  def self.list(options = {})
-    request = CentrumFaktur::Connection.new.get("/api/1.0/comments/", options)
+  def self.list(comment_uri = "/api/1.0/comments/", options = {})
+    request = CentrumFaktur::Connection.new.get(comment_uri, options)
     request.handle_response
   end
 
-  def self.create(params)
-    request = CentrumFaktur::Connection.new.post("/api/1.0/comments/", params)
+  def self.create(comment_uri, params)
+    request = CentrumFaktur::Connection.new.post(comment_uri, params)
     request.handle_response
   end
 end

data/lib/centrum_faktur/connection.rb

@@ -43,7 +43,7 @@ class CentrumFaktur::Connection
     @path = URI.parse(to).to_s
     request = Net::HTTP::Post.new(@path, headers)
     request.basic_auth(login, password)
-    request.body = params.to_json
+    request.body = MultiJson.encode(normalize_params(params))
     @response = http.request(request)
     self
   end
@@ -52,7 +52,7 @@ class CentrumFaktur::Connection
     @path = URI.parse(to).to_s
     request = Net::HTTP::Put.new(@path, headers)
     request.basic_auth(login, password)
-    request.body = params.to_json
+    request.body = MultiJson.encode(normalize_params(params))
     @response = http.request(request)
     self
   end
@@ -74,6 +74,24 @@ class CentrumFaktur::Connection
     URI.parse(path)
   end
 
+  def normalize_params(params)
+    params.inject({}) do |normalized, (key, value)|
+      normalized[key] =
+        if value.is_a?(Hash)
+         normalize_params(value)
+       elsif value.is_a?(Array)
+         value.map { |v| v.is_a?(Hash) ? normalize_params(v) : normalize_value(v) }
+       else
+         normalize_value(value)
+       end
+      normalized
+    end
+  end
+
+  def normalize_value(value)
+    value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d") : value
+  end
+
   def parse_response
     case format.to_sym
     when :json

data/lib/centrum_faktur/estimate.rb

@@ -19,6 +19,11 @@ class CentrumFaktur::Estimate
     request.handle_response
   end
 
+  def self.update(estimate_uri, params)
+    request = CentrumFaktur::Connection.new.put(estimate_uri, params)
+    request.handle_response
+  end
+
   def self.destroy(estimate_uri)
     request = CentrumFaktur::Connection.new.delete(estimate_uri)
     request.handle_response

data/lib/centrum_faktur/invoice.rb

@@ -19,6 +19,11 @@ class CentrumFaktur::Invoice
     request.handle_response
   end
 
+  def self.update(invoice_uri, params)
+    request = CentrumFaktur::Connection.new.put(invoice_uri, params)
+    request.handle_response
+  end
+
   def self.destroy(invoice_uri)
     request = CentrumFaktur::Connection.new.delete(invoice_uri)
     request.handle_response

data/lib/centrum_faktur/version.rb

@@ -1,3 +1,3 @@
 module CentrumFaktur
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/connection_test.rb

@@ -27,4 +27,38 @@ describe "Connection" do
   it "should return url to custom profile" do
     assert_equal "https://fake.centrumfaktur.pl", CentrumFaktur::Connection.new.uri.to_s
   end
+
+  it "should normalize date to required format" do
+    normalized = CentrumFaktur::Connection.new.normalize_value(Time.mktime(2012, 01, 01))
+    assert_equal "2012-01-01", normalized
+  end
+
+  it "should not normalize not Date values" do
+    normalized = CentrumFaktur::Connection.new.normalize_value("value")
+    assert_equal "value", normalized
+  end
+
+  it "should normalize params hash" do
+    params = {:body => "value", :date => Time.mktime(2012, 01, 01)}
+    normalized = CentrumFaktur::Connection.new.normalize_params(params)
+    assert_equal({:body => "value", :date => "2012-01-01"}, normalized)
+  end
+
+  it "should normalize nested params hash" do
+    params = {:body => "value", :nested => {:date => Time.mktime(2012, 01, 01)}}
+    normalized = CentrumFaktur::Connection.new.normalize_params(params)
+    assert_equal({:body => "value", :nested => {:date => "2012-01-01"}}, normalized)
+  end
+
+  it "should normalize nested array params hash" do
+    params = {:body => "value", :items => [:date1 => Time.mktime(2012, 01, 01), :date2 => Time.mktime(2012, 01, 02)]}
+    normalized = CentrumFaktur::Connection.new.normalize_params(params)
+    assert_equal({:body => "value", :items => [:date1 => "2012-01-01", :date2 => "2012-01-02"]}, normalized)
+  end
+
+  it "should normalize nested array values" do
+    params = {:body => "value", :items => [Time.mktime(2012, 01, 01), "value"]}
+    normalized = CentrumFaktur::Connection.new.normalize_params(params)
+    assert_equal({:body => "value", :items => ["2012-01-01", "value"]}, normalized)
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: centrum_faktur
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - "Wojciech Wn\xC4\x99trzak"