skippr-rb 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0d1a7e9bcb6c2111da2ba20f4cc3112cdd6a605
+  data.tar.gz: 5633a4a7f39ae5105bb1adafe6d5ba293fd2fece
+SHA512:
+  metadata.gz: 8548bc1eb8df7d3e4f6f19d6939366260661b25afd4a598ec2c98fdfea5c38c91a7d0bc891def0740a6cd5253170cd15c784f64522d8b8f0ae4ff86f8a544712
+  data.tar.gz: 023a17fb0656f7dd85dd4d1b1974861dabc0744a33a477d2680f8744ecc1d246427884303c29719288e7f25b436daea35d4b1e0aea946c51d56d847b301261dd

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sebastian M. Gauck
+
+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,89 @@
+# Skippr::Rb
+
+Skippr api gem - this is WIP!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'skippr-rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skippr-rb
+
+## Usage
+
+    Skippr::Api.configure({
+      client_name: "fortytools",
+      app_key: "awesome_skippr_app",
+      app_token: "098172398723419887",
+      client_user_api_key: "skippr_client_user_key",  # ATTENTION: has to refer to the same client as the 'client_name' does
+      client_user_api_token: "0987654321zonk",
+    })
+
+    # The Endpoint is per default configured to be
+    # https://skippr.com/api/v2
+    # so in general you're done with the configuration above
+
+
+    # But just in case you'd like to tweak this endpoint, then provide a conf hash with any of the following
+    Skippr::Api.configure_endpoint({
+      protocol: "http",
+      domain: "skippr.local",
+      port: 3030,
+      path: '/superapi/v33/',         # path is always surrounded by '/'
+      user: 'basicauthuser',          # if the api is protected by http basic auth
+      password: 'basicauthpassword',  # if the api is protected by http basic auth
+    })
+    # that's for 'http://batzen.skippr.local:3030/superapi/v33/' with basic auth
+
+
+
+    # Now use it in your models and controllers like follows:
+
+    Skippr::Customer.all
+
+    c = Skippr::Customer.new
+    c.name = "fortytools gmbh"
+    c.street = "Georgsplatz 10"
+    c.zip = "20099"
+    c.city = "Hamburg"
+    c.customer_state_id = Skippr::CustomerState.all.select{|s| s.name == "Kunde"}.first
+    c.save
+
+    i = Skippr::Invoice.new
+    i.date = Date.today
+    i.customer_id = 4711
+    i.line_items_attributes = [
+      { title: "Development Gricker.com",
+        quantity: 15,
+        price: 1234,
+        service_period_start: 5.days.ago,
+        service_period_end: 4.days.ago,
+        service_type_id: Skippr::ServiceType.all.first.id
+      }
+    ]
+    i.save
+
+
+## Thread safety
+- The Skippr::Api and Skippr::Endpoint classes are thread safe. They do not store anything in class variables but in
+  thread locals (the thread_container). Hence, you can use several threads using the code above with varying credentials
+  and endpoints without interfering with each other.
+
+## TODO
+
+- add dependencies to gemspec
+
+## 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

data/Rakefile

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

data/lib/skippr-rb.rb

@@ -0,0 +1,26 @@
+require "skippr/version"
+
+require 'active_resource'
+require "skippr/active_resource/base"
+
+require "skippr/exceptions"
+require "skippr/api"
+
+
+require "skippr/resources/account"
+require "skippr/resources/attachment_type"
+require "skippr/resources/bank_account"
+require "skippr/resources/customer"
+require "skippr/resources/customer_state"
+require "skippr/resources/event"
+require "skippr/resources/invoice"
+require "skippr/resources/invoice_position"
+require "skippr/resources/item"
+require "skippr/resources/item_category"
+require "skippr/resources/item_order"
+require "skippr/resources/offer"
+require "skippr/resources/service_type"
+require "skippr/resources/supplier"
+require "skippr/resources/task"
+require "skippr/resources/unit"
+require "skippr/resources/user"

data/lib/skippr/active_resource/base.rb

@@ -0,0 +1,43 @@
+class ActiveResource::Base
+  class << self
+
+    def reset_connection
+      @connection = nil
+    end
+
+=begin
+    def site=site
+      thread_container['site'] = site
+    end
+    def site
+      s = thread_container['site']
+      if s.is_a?(String)
+        URI.parse(s)
+      else
+        s
+      end
+    end
+
+    def password=password
+      thread_container['password'] = password
+    end
+    def password
+      thread_container['password']
+    end
+
+    def user=user
+      thread_container['user'] = user
+    end
+    def user
+      thread_container['user']
+    end
+
+    def thread_container
+      Thread.current['active_resource.conf'] ||= {}
+      Thread.current['active_resource.conf']
+    end
+=end
+
+
+  end
+end

data/lib/skippr/api.rb

@@ -0,0 +1,171 @@
+module Skippr
+
+  class Api < ActiveResource::Base
+
+
+    def get(custom_method_name, options={})
+      super(custom_method_name, options.merge(self.class.auth_params))
+    end
+    def post(custom_method_name, options={})
+      super(custom_method_name, options.merge(self.class.auth_params))
+    end
+    def put(custom_method_name, options={})
+      super(custom_method_name, options.merge(self.class.auth_params))
+    end
+    def delete(custom_method_name, options={})
+      super(custom_method_name, options.merge(self.class.auth_params))
+    end
+
+
+    class << self
+
+      ### ActiveResource API
+      timeout = 30
+      def include_root_in_json
+        false
+      end
+
+      # Thread safety for active_resource, see monkey patch in monkey.rb
+
+      def element_path(id, prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        query_options = ( query_options || {} ).merge(self.auth_params)
+        "#{prefix(prefix_options)}#{collection_name}/#{id}#{query_string(query_options)}"
+      end
+
+      def collection_path(prefix_options = {}, query_options = nil)
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        query_options = ( query_options || {} ).merge(self.auth_params)
+        "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+      end
+
+      def get(custom_method_name, options={})
+        super(custom_method_name, options.merge(self.auth_params))
+      end
+      def post(custom_method_name, options={})
+        super(custom_method_name, options.merge(self.auth_params))
+      end
+      def put(custom_method_name, options={})
+        super(custom_method_name, options.merge(self.auth_params))
+      end
+      def delete(custom_method_name, options={})
+        super(custom_method_name, options.merge(self.auth_params))
+      end
+
+      ### END ActiveResource API
+
+      def valid?
+        begin
+          uri = URI.parse(self.site.to_s + 'auth/valid?' + self.auth_params.to_param)
+          http = Net::HTTP.new(uri.host, uri.port)
+          if self.site.scheme == 'https'
+            http.use_ssl= true
+          end
+          rq = Net::HTTP::Get.new(uri.request_uri)
+          unless self.user.blank?
+            rq.basic_auth(self.user, self.password)
+          end
+          response = http.request(rq)
+          body = response.read_body
+          if response.code == '200' && body == 'Ok'
+            true
+          else
+            Rails.logger.info "Server responded: (#{response.code}) #{body}"
+            false
+          end
+
+        rescue Timeout::Error
+          Rails.logger.warn "timeout"
+          false
+        rescue Errno::ECONNREFUSED
+          Rails.logger.warn "no api connection"
+          false
+        rescue
+          Rails.logger.info "exception when trying to authenticate"
+          false
+        end
+      end
+
+      # Thread safe auth params
+      def auth_params
+        assert_configuration!(self.thread_container)
+
+        valid_until = 1.hour.from_now
+        sig_src = [self.client_user_api_token, self.app_token, valid_until.to_time.to_i.to_s].join(":")
+        signature = Digest::SHA2.hexdigest(sig_src)
+        {
+          app:        self.app_key,
+          user:       self.client_user_api_key,
+          validuntil: valid_until.to_time.to_i.to_s,
+          signature:  signature
+        }
+      end
+
+
+      def configure(configuration_hash)
+        configuration_hash.each do |key, value|
+          self.thread_container["#{key}"] = value
+        end
+
+        reset_connection
+      end
+
+      def configure_endpoint(configuration_hash)
+        configuration_hash[:protocol] ||= "https"
+        configuration_hash[:domain] ||= "skippr.com"
+        endpoint_site = [configuration_hash[:protocol], configuration_hash[:domain]].join("://")
+        endpoint_site += ":" + configuration_hash[:port].to_s if configuration_hash[:port].present?
+        self.site = endpoint_site + "/api/v2/"
+        reset_connection
+      end
+
+      def client_name
+        self.thread_container['client_name']
+      end
+
+      def app_key
+        self.thread_container['app_key']
+      end
+
+      def app_token
+        self.thread_container['app_token']
+      end
+
+      def client_user_api_key
+        self.thread_container['client_user_api_key']
+      end
+
+      def client_user_api_token
+        self.thread_container['client_user_api_token']
+      end
+
+      def thread_container
+        Thread.current['skippr.api.conf'] ||= {}
+        Thread.current['skippr.api.conf']
+      end
+
+      def assert_configuration!(conf_hash)
+        required_confs = [:app_key, :app_token, :client_user_api_key, :client_user_api_token, :client_name]
+
+        unknowns = conf_hash.symbolize_keys.except(*required_confs)
+        unless unknowns.empty?
+          raise Skippr::UnknownConfigurationError.new("Unknown in api configuration: #{unknowns.keys}")
+        end
+
+        missings = required_confs - conf_hash.symbolize_keys.keys
+        unless missings.empty?
+          raise Skippr::MissingConfigurationError.new("Missing in api configuration: #{missings}")
+        end
+      end
+    end
+
+
+  end
+
+  # Delegator for convenience, checks whether current skippr api settings allow for a valid connection
+  def self.valid?
+    Api.valid?
+  end
+end
+
+

data/lib/skippr/exceptions.rb

@@ -0,0 +1,8 @@
+module Skippr
+
+  class MissingConfigurationError < StandardError
+  end
+  class UnknownConfigurationError < StandardError
+  end
+
+end

data/lib/skippr/resources/account.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Account < Api
+
+  end
+end

data/lib/skippr/resources/attachment_type.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class AttachmentType <  Api
+
+  end
+end

data/lib/skippr/resources/bank_account.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class BankAccount < Api
+
+  end
+end

data/lib/skippr/resources/customer.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Customer < Api
+
+  end
+end

data/lib/skippr/resources/customer_state.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class CustomerState < Api
+
+  end
+end

data/lib/skippr/resources/employee.rb

@@ -0,0 +1,6 @@
+module Skippr
+  class Employee < Api
+
+  end
+end
+

data/lib/skippr/resources/event.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Event < Api
+
+  end
+end

data/lib/skippr/resources/invoice.rb

@@ -0,0 +1,21 @@
+module Skippr
+  class Invoice < Api
+
+    ACCOUNTED = 0
+    PRINTED = 1
+    DRAFT = 4
+
+    def accounted?
+      state == ACCOUNTED
+    end
+
+    def printed?
+      state <= PRINTED
+    end
+
+    def draft?
+      state == DRAFT
+    end
+
+  end
+end

data/lib/skippr/resources/invoice_position.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class InvoicePosition < Api
+
+  end
+end

data/lib/skippr/resources/item.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Item < Api
+
+  end
+end

data/lib/skippr/resources/item_category.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class ItemCategory < Api
+
+  end
+end

data/lib/skippr/resources/item_order.rb

@@ -0,0 +1,13 @@
+module Skippr
+  class ItemOrder < Api
+
+    def draft?
+      number.nil?
+    end
+
+    def printed?
+      !draft?
+    end
+
+  end
+end

data/lib/skippr/resources/offer.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Offer < Api
+
+  end
+end

data/lib/skippr/resources/service_type.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class ServiceType <  Api
+
+  end
+end

data/lib/skippr/resources/supplier.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Supplier < Api
+
+  end
+end

data/lib/skippr/resources/task.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Task < Api
+
+  end
+end

data/lib/skippr/resources/unit.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class Unit < Api
+
+  end
+end

data/lib/skippr/resources/user.rb

@@ -0,0 +1,5 @@
+module Skippr
+  class User < Api
+
+  end
+end

data/lib/skippr/version.rb

@@ -0,0 +1,3 @@
+module Skippr
+  VERSION = "0.0.3"
+end

data/skippr-rb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skippr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skippr-rb"
+  spec.version       = Skippr::VERSION
+  spec.authors       = ["Sebastian M. Gauck"]
+  spec.email         = ["smg@42ls.de"]
+  spec.description   = %q{gem to consume the api of our invoicing tool https://skippr.com}
+  spec.summary       = %q{skippr api gem}
+  spec.homepage      = "http://github.com/fortytools/skippr-rb"
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency("activeresource")
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: skippr-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sebastian M. Gauck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activeresource
+  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'
+description: gem to consume the api of our invoicing tool https://skippr.com
+email:
+- smg@42ls.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/skippr-rb.rb
+- lib/skippr/active_resource/base.rb
+- lib/skippr/api.rb
+- lib/skippr/exceptions.rb
+- lib/skippr/resources/account.rb
+- lib/skippr/resources/attachment_type.rb
+- lib/skippr/resources/bank_account.rb
+- lib/skippr/resources/customer.rb
+- lib/skippr/resources/customer_state.rb
+- lib/skippr/resources/employee.rb
+- lib/skippr/resources/event.rb
+- lib/skippr/resources/invoice.rb
+- lib/skippr/resources/invoice_position.rb
+- lib/skippr/resources/item.rb
+- lib/skippr/resources/item_category.rb
+- lib/skippr/resources/item_order.rb
+- lib/skippr/resources/offer.rb
+- lib/skippr/resources/service_type.rb
+- lib/skippr/resources/supplier.rb
+- lib/skippr/resources/task.rb
+- lib/skippr/resources/unit.rb
+- lib/skippr/resources/user.rb
+- lib/skippr/version.rb
+- skippr-rb.gemspec
+homepage: http://github.com/fortytools/skippr-rb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: skippr api gem
+test_files: []