fakturownia_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0feb037e85b52731732c639ec90277417840ac7
+  data.tar.gz: f2ce6405b249a71076262794cd7d0fa24e384562
+SHA512:
+  metadata.gz: 7bc2c5ca4fea74cfcefc410bf12b713bfff60a09b5a80ba9e065f22c0379382a2035b5fd7e53a732a6eb5fdc61c54f7cfdb050bf3f9e215fc69e2fc2f18afd30
+  data.tar.gz: 0cac2d26746d53a5ff522be8b7d98a0d01bb7f35ec10f91f7ad6276028955c43dcded68fde295f571a8767a40324f880f48599431199a3603fcf105b39a9be86

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fakturownia.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sebastian Wojtczak
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Fakturownia
+
+Ruby wrapper around API of invoice service fakturownia.pl
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fakturownia'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fakturownia
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/fakturownia.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fakturownia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fakturownia_api"
+  spec.version       = Fakturownia::VERSION
+  spec.authors       = ["Shelly Cloud team"]
+  spec.email         = ["devs@shellycloud.com"]
+  spec.summary       = %q{Ruby API for invoicing service fakturownia.pl}
+  spec.homepage      = "https://github.com/shellycloud/fakturownia"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "fakeweb"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+end

data/lib/fakturownia/api/base.rb

@@ -0,0 +1,15 @@
+module Fakturownia
+  module Api
+    class Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def connection
+        @connection ||= Fakturownia::Connection.new(client)
+      end
+    end
+  end
+end

data/lib/fakturownia/api/invoice.rb

@@ -0,0 +1,25 @@
+module Fakturownia
+  module Api
+    class Invoice < Base
+      def list(options = {})
+        connection.get("/invoices", options)
+      end
+
+      def show(id, options = {})
+        connection.get("/invoices/#{id}", options)
+      end
+
+      def create(params)
+        connection.post("/invoices", invoice: params)
+      end
+
+      def update(id, params)
+        connection.put("/invoices/#{id}", invoice: params)
+      end
+
+      def delete(id)
+        connection.delete("/invoices/#{id}")
+      end
+    end
+  end
+end

data/lib/fakturownia/client.rb

@@ -0,0 +1,16 @@
+module Fakturownia
+  class Client
+    attr_reader :subdomain, :api_token
+
+    def initialize(options = {})
+      @subdomain = options[:subdomain] ||
+        raise(ArgumentError.new('subdomain is required'))
+      @api_token = options[:api_token] ||
+        raise(ArgumentError.new('api_token is required'))
+    end
+
+    def invoice
+      Fakturownia::Api::Invoice.new(self)
+    end
+  end
+end

data/lib/fakturownia/connection.rb

@@ -0,0 +1,86 @@
+require "rest_client"
+require "json"
+
+module Fakturownia
+  class Connection
+    attr_reader :client, :format
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get(path, options = {})
+      @format = options.fetch(:format, :json)
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    def request(method, path, options = {})
+      options = request_parameters(method, path, options)
+      RestClient::Request.execute(options) do |response, request|
+        process_response(response)
+      end
+    end
+
+    def process_response(response)
+      case response.code.to_i
+      when 200...300
+        body = parse(response)
+      else
+        raise Fakturownia::APIException.new(response.body, response.code)
+      end
+      response.return!
+      body
+    end
+
+    def parse(response)
+      case format
+      when :json
+        JSON.parse(response.body) rescue JSON::ParserError && {}
+      when :pdf
+        response.body
+      else
+        raise StandardError.new("Unknown format #{format}")
+      end
+    end
+
+    def request_parameters(method, path, options = {})
+      parameters = {
+        method:  method,
+        url:     "#{api_url}#{path}.#{format}",
+        headers: headers
+
+      }
+      unless [:get, :head].include?(method)
+        parameters = parameters.merge(payload: options.to_json)
+      end
+      parameters
+    end
+
+    def format
+      @format ||= :json
+    end
+
+    def api_url
+      "https://#{client.subdomain}.fakturownia.pl"
+    end
+
+    def headers
+      {accept:       :json,
+       content_type: :json,
+       params: {api_token: client.api_token}
+      }
+    end
+  end
+end

data/lib/fakturownia/errors.rb

@@ -0,0 +1,14 @@
+module Fakturownia
+  class APIException < Exception
+    attr_reader :code, :body
+
+    def initialize(body, code)
+      @code = code
+      @body = body
+    end
+
+    def inspect
+      [code, body].join(" - ")
+    end
+  end
+end

data/lib/fakturownia/version.rb

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

data/lib/fakturownia.rb

@@ -0,0 +1,6 @@
+require "fakturownia/version"
+require "fakturownia/errors"
+require "fakturownia/client"
+require "fakturownia/connection"
+require "fakturownia/api/base"
+require "fakturownia/api/invoice"

data/spec/api/invoice_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Fakturownia::Api::Invoice do
+  let(:client) { Fakturownia::Client.new(subdomain: "test", api_token: "123") }
+  subject { described_class.new(client) }
+  let(:connection) { subject.connection }
+
+  describe "#list" do
+    it "should perform GET request on connection at '/invoices'" do
+      expect(connection).to receive(:get).with('/invoices', period: 'this_month')
+      subject.list(period: 'this_month')
+    end
+  end
+
+  describe "#get" do
+    it "should perform GET request on connection at '/invoices'" do
+      expect(connection).to receive(:get).with('/invoices/123', format: :pdf)
+      subject.show(123, format: :pdf)
+    end
+  end
+
+  describe "#create" do
+    it "should perform POST request on connection at '/invoices'" do
+      expect(connection).to receive(:post).with('/invoices',
+        invoice: {buyer: 'John Doe'})
+      subject.create(buyer: 'John Doe')
+    end
+  end
+
+  describe "#list" do
+    it "should perform PUT request on connection at '/invoices'" do
+      expect(connection).to receive(:put).with('/invoices/123',
+        invoice: {buyer: 'John Doe'})
+      subject.update(123, buyer: 'John Doe')
+    end
+  end
+
+  describe "#list" do
+    it "should perform DELETE request on connection at '/invoices'" do
+      expect(connection).to receive(:delete).with('/invoices/123')
+      subject.delete(123)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Fakturownia::Client do
+  subject { described_class.new(subdomain: "test", api_token: "123") }
+
+  it "api_token is required" do
+    expect { Fakturownia::Client.new(subdomain: "test") }.
+      to raise_error(ArgumentError, 'api_token is required')
+  end
+
+  it "api_token is required" do
+    expect { Fakturownia::Client.new(api_token: "test") }.
+      to raise_error(ArgumentError, 'subdomain is required')
+  end
+
+  describe "#invoice" do
+    it "should return Invoice class" do
+      expect(Fakturownia::Api::Invoice).to receive(:new).with(subject)
+      subject.invoice
+    end
+  end
+end

data/spec/connection_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Fakturownia::Connection do
+  let(:client) { Fakturownia::Client.new(subdomain: 'test', api_token: '123') }
+  subject { Fakturownia::Connection.new(client) }
+
+  describe "#request" do
+    it "should get request parameters" do
+      expect(RestClient::Request).to receive(:execute).with(
+        {method: :get,
+         url: "https://test.fakturownia.pl/invoices.json",
+         headers: {accept: :json, content_type: :json, params: {api_token: '123'}}
+        }
+      )
+      subject.request(:get, "/invoices", {sth: "foo"})
+    end
+
+    it "should pass response to process_response method" do
+      response = double(RestClient::Response)
+      request = double(RestClient::Request)
+      expect(subject).to receive(:process_response).with(response)
+      allow(RestClient::Request).to receive(:execute).and_yield(response, request)
+      subject.request("/invoices", :get)
+    end
+  end
+
+
+  describe "#process_response" do
+    let(:response) { double(RestClient::Response, code: 200, body: "{}",
+      return!: nil) }
+    let(:request) { double(RestClient::Request) }
+
+    before do
+      allow(RestClient::Request).to receive(:execute).and_yield(response, request)
+    end
+
+    it "should not follow redirections" do
+      expect(response).to receive(:return!)
+      subject.get('/invoices')
+    end
+
+    it "should parse JSON" do
+      allow(response).to receive(:body).and_return({ok: true}.to_json)
+      expect(subject.get("/invoices")).to eq('ok' => true)
+    end
+
+    it "should return body for PDF" do
+      allow(subject).to receive(:format).and_return(:pdf)
+      allow(response).to receive(:body).and_return("pdf content")
+      expect(subject.get("/invoices")).to eq("pdf content")
+    end
+
+    it "should return empty hash if response is not a valid JSON" do
+      expect(JSON).to receive(:parse).with("").and_raise(JSON::ParserError)
+      allow(response).to receive(:body).and_return("")
+      expect(subject.post("/invoices")).to eq({})
+    end
+
+    context "on unsupported response" do
+      it "should raise generic APIException" do
+        allow(response).to receive(:code).and_return(500)
+        allow(response).to receive(:body).and_return("")
+        expect { subject.post("/") }.to raise_error { |error|
+          expect(error).to be_a(Fakturownia::APIException)
+          expect(error.body).to eq("")
+          expect(error.code).to eq(500)
+        }
+      end
+    end
+  end
+
+  describe "#get" do
+    it "should make GET request to given path" do
+      expect(subject).to receive(:request).with(:get, "/invoices", {})
+      subject.get("/invoices")
+    end
+  end
+
+  describe "#post" do
+    it "should make POST request to given path with parameters" do
+      expect(subject).to receive(:request).with(:post, "/invoices", name: "pink-one")
+      subject.post("/invoices", name: "pink-one")
+    end
+  end
+
+  describe "#put" do
+    it "should make PUT resquest to given path with parameters" do
+      expect(subject).to receive(:request).with(:put, "/invoices", name: "new-one")
+      subject.put("/invoices", name: "new-one")
+    end
+  end
+
+  describe "#delete" do
+    it "should make DELETE request to given path with parameters" do
+      expect(subject).to receive(:request).with(:delete, "/invoices", name: "new-one")
+      subject.delete("/invoices", name: "new-one")
+    end
+
+    it "should make DELETE request to apps with parameters" do
+      expect(subject).to receive(:request).with(:delete, "/invoices/1", {})
+      subject.delete("/invoices/1")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'fakturownia'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fakturownia_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shelly Cloud team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email:
+- devs@shellycloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fakturownia.gemspec
+- lib/fakturownia.rb
+- lib/fakturownia/api/base.rb
+- lib/fakturownia/api/invoice.rb
+- lib/fakturownia/client.rb
+- lib/fakturownia/connection.rb
+- lib/fakturownia/errors.rb
+- lib/fakturownia/version.rb
+- spec/api/invoice_spec.rb
+- spec/client_spec.rb
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shellycloud/fakturownia
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby API for invoicing service fakturownia.pl
+test_files:
+- spec/api/invoice_spec.rb
+- spec/client_spec.rb
+- spec/connection_spec.rb
+- spec/spec_helper.rb