fakturownia_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0feb037e85b52731732c639ec90277417840ac7
-  data.tar.gz: f2ce6405b249a71076262794cd7d0fa24e384562
+  metadata.gz: cefc739c7f5b142dd7b16d725656aa1ad896bade
+  data.tar.gz: 1e6e2560411f84515b1231980ccffe171c39acc0
 SHA512:
-  metadata.gz: 7bc2c5ca4fea74cfcefc410bf12b713bfff60a09b5a80ba9e065f22c0379382a2035b5fd7e53a732a6eb5fdc61c54f7cfdb050bf3f9e215fc69e2fc2f18afd30
-  data.tar.gz: 0cac2d26746d53a5ff522be8b7d98a0d01bb7f35ec10f91f7ad6276028955c43dcded68fde295f571a8767a40324f880f48599431199a3603fcf105b39a9be86
+  metadata.gz: 047acfb8f4ac09d15c2e64e49862f66719c01ea8fe305d9f3b3c9308377ce37165dd738dd90607fd191008cc03ef2ab210dce746359207292c81b8a61f07b305
+  data.tar.gz: 041f81857e15e0563f02628ddb6ef600fad71c9e021eb8df1334ae3c7b40fcef7435b46b3ed6ab5ef95b8ca4f57fd338a9e6a413ccfaadc6c48c1e78b934b7a8

data/README.md

@@ -7,7 +7,7 @@ Ruby wrapper around API of invoice service fakturownia.pl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'fakturownia'
+gem 'fakturownia_api'
 ```
 
 And then execute:
@@ -16,16 +16,49 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install fakturownia
+    $ gem install fakturownia_api
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a client with `api_token` and `subdomain`:
+
+    client = Fakturownia::Client.new(api_token: 'YOUR_TOKEN', subdomain: 'YOUR_DOMAIN')
+
+
+### Invoices
+
+Create invoice with ([full list of available options](https://github.com/fakturownia/api/)):
+
+```ruby
+invoice = {
+  buyer_name: 'Name',
+  buyer_tax_no: ''
+  positions: [
+    {name: 'Product 1', total_price_gross: 10.0, quantity: 2},
+    {name: 'Product 2', total_price_gross: 20.0, quantity: 4}
+  ]
+}
+
+client.invoice.create(ruby_hash)
+```
+
+Download invoice as PDF
+
+    client.invoice.show(id, format: :pdf)
+
+Change invoice state
+
+    client.invoice.change_status(id, 'paid')
+
+
+## TODO
+
+Currently only invoice resource is supported.
 
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/fakturownia/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes and tests (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request

data/lib/fakturownia/api/invoice.rb

@@ -20,6 +20,11 @@ module Fakturownia
       def delete(id)
         connection.delete("/invoices/#{id}")
       end
+
+      def change_status(id, status)
+        connection.post("/invoices/#{id}/change_status",
+          invoice: {status: status})
+      end
     end
   end
 end

data/lib/fakturownia/client.rb

@@ -12,5 +12,6 @@ module Fakturownia
     def invoice
       Fakturownia::Api::Invoice.new(self)
     end
+    alias_method :invoices, :invoice
   end
 end

data/lib/fakturownia/version.rb

@@ -1,3 +1,3 @@
 module Fakturownia
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/api/invoice_spec.rb

@@ -41,4 +41,12 @@ describe Fakturownia::Api::Invoice do
       subject.delete(123)
     end
   end
+
+  describe "#change_status" do
+    it "should perform POST request on connection at /invoices/ID/change_status" do
+      expect(connection).to receive(:post).with('/invoices/123/change_status',
+        invoice: {status: 'paid'})
+      subject.change_status(123, 'paid')
+    end
+  end
 end

data/spec/client_spec.rb

@@ -19,4 +19,11 @@ describe Fakturownia::Client do
       subject.invoice
     end
   end
+
+  describe '#invoices' do
+    it 'is an alias of #invoice' do
+      expect(subject.invoices).to be_instance_of(subject.invoice.class)
+      expect(subject.invoices.client).to be(subject.invoice.client)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakturownia_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shelly Cloud team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client