fakturownia 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.1
+* Initial release.

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) 2013 Krzysztof Kempiński
+
+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,88 @@
+# Fakturownia
+
+This gem provides integration with polish invoicing system www.fakturownia.pl
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fakturownia'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fakturownia
+
+Execute:
+
+	$ bundle install
+	$ rails generate fakturownia:install
+
+
+After installation you have to set two options in config/initializers/fakturownia.rb
+
+* api\_token - after register in fakturownia.pl you will have this token
+* account\_name - after login to fakturownia.pl is a first part of URL
+
+## Usage
+
+Get invoice based in invoice ID provided after creation from fakturownia.pl:
+
+    Fakturownia::API.invoice(123456)
+
+Get invoices from given time period:
+
+    Fakturownia::API.invoices(period, date_from, date_to)
+
+where:
+
+* period is one of the [:all, :this\_month, :last\_month, :this\_year, :last\_year, :more]. If period = :more than date\_from and date\_to has to be set
+* date\_from and date\_to - dates
+
+
+Get invoice as a PDF:
+
+    Fakturownia::API.pdf(123456)
+
+
+Add new invoice:
+
+    Fakturownia::API.create(invoice_json)
+
+where invoice\_json is a hash with invoice data.
+
+
+Update previously added invoice with invoice\_id from fakturownia.pl:
+
+    Fakturownia::API.update(invoice_id, invoice_json)
+
+
+Delete previously added invoice with invoice\_id from fakturownia.pl: 
+
+    Fakturownia::API.delete(invoice_id)
+
+
+
+More details in API requests and invoice JSON structure: https://app.fakturownia.pl/api
+
+## TODO
+
+* tests
+* products
+* clients
+* payments
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+This gem is licensed under the MIT License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

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"
+  spec.version       = Fakturownia::VERSION
+  spec.authors       = ["Krzysztof Kempiński"]
+  spec.email         = ["kkempin@gmail.com"]
+  spec.description   = %q{This gem gives integration with polish on-line invoicing service: http://fakturownia.pl}
+  spec.summary       = %q{Integration with fakturownia.pl}
+  spec.homepage      = "https://github.com/kkempin/fakturownia"
+  spec.license       = "MIT" 
+
+  spec.files         = `git ls-files`.split($/)
+  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.required_rubygems_version = ">= 1.3.6"
+  spec.add_dependency "rails", ">= 3.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/fakturownia.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require "net/https"
+require "fakturownia/version"
+require "fakturownia/api"
+
+module Fakturownia
+
+  # API token
+  mattr_accessor :api_token
+
+  # Account name
+  mattr_accessor :account_name
+
+  def self.setup
+    yield self
+  end
+end

data/lib/fakturownia/api.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+module Fakturownia
+  module API
+
+    # Get JSON-formatted invoice based on invoice id (from Fakturownia)
+    def self.invoice invoice_id
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices/#{invoice_id}.json"
+      response = self.make_get_request(endpoint)
+
+      (response.code == '200') ? JSON.parse(response.body) : nil 
+    end
+
+    # Get JSON-formatted invoice based on order id
+    def self.invoice_by_order_id order_id
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices"
+      response = self.make_get_request(endpoint, { :oid => order_id })
+
+      (response.code == '200') ? JSON.parse(response.body) : nil 
+    end
+
+    # Get JSON-formatted invoices based from given period
+    # Available periods = [:all, :this_month, :last_month, :this_year, :last_year, :more]
+    # If period = :more than date_from and date_to has to be set
+    def self.invoices period, date_from = nil, date_to = nil
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices.json?period=#{period}"
+      additional_params = { :period => period }
+      if period.to_s == 'more'
+        additional_params[:date_from] = date_from
+        additional_params[:date_to] = date_to
+      end
+      response = self.make_get_request(endpoint, additional_params)
+
+      (response.code == '200') ? JSON.parse(response.body) : nil 
+    end
+
+    # Get invoice PDF based on invoice id
+    def self.pdf invoice_id
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices/#{invoice_id}.pdf"
+      response = self.make_get_request(endpoint)
+       
+      (response.code == '200') ? response.body : nil
+    end
+
+
+    # Create new invoice
+    def self.create invoice_json
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices.json"
+      uri = URI.parse(endpoint) 
+
+      json_params = { 
+        "api_token" => Fakturownia.api_token,
+        "invoice" => invoice_json
+      }
+
+      request = Net::HTTP::Post.new(uri.path) 
+      request.body = JSON.generate(json_params) 
+      request["Content-Type"] = "application/json" 
+      http = Net::HTTP.new(uri.host, uri.port) 
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.start {|h| h.request(request)} 
+      (response.code == '201') ? JSON.parse(response.body) : nil
+    end
+
+
+    # Update invoice
+    # invoice_id - id of invoice from fakturownia
+    def self.update invoice_id, invoice_json
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices/#{invoice.fakturownia_id}.json"
+      uri = URI.parse(endpoint) 
+
+      json_params = { 
+        "api_token" => Fakturownia.api_token,
+        "invoice" => invoice_json
+      }
+
+      request = Net::HTTP::Put.new(uri.path) 
+      request.body = JSON.generate(json_params) 
+      request["Content-Type"] = "application/json" 
+      http = Net::HTTP.new(uri.host, uri.port) 
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.start {|h| h.request(request)} 
+
+      (response.code == '201') ? JSON.parse(response.body) : nil
+    end
+
+
+    # Delete invoice
+    def self.delete invoice_id
+      endpoint = "https://#{Fakturownia.account_name}.fakturownia.pl/invoices/#{invoice_id}.json"
+      uri = URI.parse(endpoint) 
+      whole_url = uri.path + "?api_token=#{Fakturownia.api_token}"
+
+      http = Net::HTTP.new(uri.host, uri.port) 
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.delete(whole_url)
+    end
+
+    
+    # Make GET request returning response
+    def self.make_get_request endpoint, additional_params = {}
+      uri = URI.parse(endpoint)
+      whole_url = uri.path + "?api_token=#{Fakturownia.api_token}"
+      additional_params.each_pair do |k, v|
+        whole_url += "&#{k}=#{v}"
+      end
+
+      request = Net::HTTP::Get.new(whole_url) 
+      http = Net::HTTP.new(uri.host, uri.port) 
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.start {|h| h.request(request)}
+    end
+
+  end
+end

data/lib/fakturownia/version.rb

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

data/lib/generators/fakturownia/install_generator.rb

@@ -0,0 +1,14 @@
+module Fakturownia
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      @@root = File.expand_path("../../templates", __FILE__)
+      source_root @@root
+
+      desc "Copy files ..."
+
+      def copy_initializer
+        template "fakturownia.rb", "config/initializers/fakturownia.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/fakturownia.rb

@@ -0,0 +1,8 @@
+Fakturownia.setup do |config|
+
+  # API token
+  config.api_token = 'xxx'
+
+  # Account name, comes from your base URL: xxx.fakturownia.pl
+  config.account_name = 'xxx'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: fakturownia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Krzysztof Kempiński
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'This gem gives integration with polish on-line invoicing service:
+  http://fakturownia.pl'
+email:
+- kkempin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fakturownia.gemspec
+- lib/fakturownia.rb
+- lib/fakturownia/api.rb
+- lib/fakturownia/version.rb
+- lib/generators/fakturownia/install_generator.rb
+- lib/generators/templates/fakturownia.rb
+homepage: https://github.com/kkempin/fakturownia
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2964144164709439946
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Integration with fakturownia.pl
+test_files: []