tfso 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e84e4419a9837d5aefce99cefe5f229a159f48e
+  data.tar.gz: 7d9aa4955e980c00298d908c24dee2acefd9f846
+SHA512:
+  metadata.gz: '00429c76a3c2cb3ff745cdbf225514f62434e970bc80c1bddc1d3a05edf0b6d69e2e40fd0d52554ffad737f549fc44b2db2b89a310d7ea913cfc8504d660d1e9'
+  data.tar.gz: 4c4aa109410db98c8d55b5870ac2e76c9f609ecaf5a64958fe5bb632fb119bbdcad2dd2c79acf56dfefa05cff29b6cc797f89bf3a5adcb77c378befef7f31e91

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tfso.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Espen Antonsen
+
+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,62 @@
+# 24SevenOffice Ruby API wrapper
+
+Please see https://24SevenOffice.com for more information. API Documentation can be found at http://developer.24sevenoffice.com.
+
+You need an ApplicationID from 24SevenOffice to use the API in addition to API credentials.
+
+Sorry for the lack of tests. It was a bit tedious to modify internal tests with sensitive responses to this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tfso'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tfso
+
+## Usage
+
+```
+tfso_auth = TFSO::Authentication.new(APPLICATION_ID)
+tfso_auth.authenticate(
+  USERNAME,
+  PASSWORD,
+  IDENTIDY_ID
+)
+puts tfso_auth.identities
+
+tfso_company = TFSO::Company.new(tfso_auth)
+company_attributes = {
+  name: 'Inspired AS',
+  email: 'espen@inspired.no',
+  tfso: {
+    DistributionMethod: 'EMail'
+  }
+}
+company = tfso_company.create( tfso_company.transform_attributes(company_attributes) )
+puts company[:id]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+When using this gem in a Rails project within the development environment it is set up to use a local proxy at http://localhost:8080 to inspect traffic. A local proxy can be set up using https://mitmproxy.org.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/espen/tfso.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tfso"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tfso.rb

@@ -0,0 +1,8 @@
+require 'savon'
+require "tfso/version"
+require 'tfso/helpers'
+require 'tfso/authentication'
+require 'tfso/company'
+require 'tfso/invoice'
+require 'tfso/payment'
+require 'tfso/product'

data/lib/tfso/authentication.rb

@@ -0,0 +1,43 @@
+module TFSO
+
+  class Authentication
+
+    include TFSO::Helpers
+
+    URL = 'https://api.24sevenoffice.com/authenticate/v001/authenticate.asmx?wsdl'
+
+    attr_accessor :application_id
+
+    def initialize(application_id)
+      @application_id = application_id
+      intialize_savon_client
+    end
+
+    def authenticated?
+      response = savon_client.call(:has_session, cookies: @cookies )
+      response.body[:has_session_response][:has_session_result]
+    end
+
+    def authenticate(username, password, identity_id = nil)
+      response = savon_client.call(:login, message: { credential: {Username: username, Password: password, IdentityId: identity_id, ApplicationId: application_id} })
+      self.session_id = response.body[:login_response][:login_result]
+    end
+
+    def identities
+      response = savon_client.call(:get_identities, cookies: @cookies )
+      response.body[:get_identities_response][:get_identities_result].first.last
+    end
+
+    def identity_id
+      response = savon_client.call(:get_identity, cookies: @cookies)
+      response.body[:get_identity_response][:get_identity_result][:id]
+    end
+
+    def identity_id=(identity_id)
+      response = savon_client.call(:set_identity_by_id, message: {identityId: identity_id}, cookies: @cookies)
+      @identity_id = identity_id
+    end
+
+  end
+
+end

data/lib/tfso/company.rb

@@ -0,0 +1,107 @@
+module TFSO
+  class Company
+
+    include TFSO::Helpers
+
+    URL = 'https://api.24sevenoffice.com/CRM/Company/V001/CompanyService.asmx?wsdl'
+
+    def initialize(auth)
+      self.session_id = auth.session_id
+      intialize_savon_client
+    end
+
+    def find(search_params)
+      response = savon_client.call(:get_companies, message: {searchParams: search_params, returnProperties: {string: ['Id', 'OrganizationNumber', 'NickName', 'Country', 'Addresses', 'EmailAddresses', 'PhoneNumbers', 'InvoiceLanguage', 'TypeGroup', 'DistributionMethod', 'Currency'] } }, cookies: @cookies)
+      result = response.body[:get_companies_response][:get_companies_result]
+      if result
+        if result[:company].class == Hash
+          [result[:company]]
+        else
+          result[:company]
+        end
+      else
+        []
+      end
+    end
+
+    def find_by_id(id)
+      if company = find(CompanyId: id)
+        company.first
+      end
+    end
+
+    def find_by_name(name)
+      find(CompanyName: name)
+    end
+
+    def create(company_info)
+      response = savon_client.call(:save_companies, message: {companies: [{Company: company_info}] }, cookies: @cookies)
+      result = response.body[:save_companies_response][:save_companies_result]
+      if result
+        if result[:company].class == Hash
+          if result[:company][:api_exception]
+            raise "Error when saving tfso company"
+          else
+            result[:company]
+          end
+        else
+          result[:company]
+        end
+      else
+        false
+      end
+    end
+
+    def transform_attributes(company)
+      if company[:billing_id]
+        company[:id] = company.delete(:billing_id)
+      else
+        company[:Type] = 'Business'
+      end
+      if company[:billing_name]
+        company[:nickname] = company.delete(:name)
+        company[:name] = company.delete(:billing_name)
+      end
+      if company[:billing_email]
+        company[:EmailAddresses] = {:Invoice => {
+            :Value => company.delete(:billing_email)
+          }
+        }
+      end
+      if company[:email]
+        company[:EmailAddresses] = {:Work => {
+            :Value => company.delete(:email)
+          }
+        }
+      end
+      if company[:phone_number]
+        company[:PhoneNumbers] = {:Work => {
+            :Value => company.delete(:phone_number)
+          }
+        }
+      end
+      if company[:billing_address]
+        company[:Addresses] = {:Invoice => {
+            :Name => company.delete(:billing_name) || company[:name],
+            :Street => company.delete(:billing_street),
+            :PostalCode => company.delete(:billing_postal_code),
+            :PostalArea => company.delete(:billing_city),
+            :State => company.delete(:billing_state),
+            :Country => company.delete(:billing_country_code)
+          }
+        }
+        company.delete(:billing_address)
+      end
+      if company[:tfso]
+        company[:tfso].keys.each{|k| company[k] = company[:tfso].delete(k) }
+        company.delete(:tfso)
+      end
+
+      mappings = {:name => :Name, :nickname => :NickName, :gov_no => :OrganizationNumber, :country_code => :Country}
+
+      company.keys.each { |k| company[ mappings[k] ] = company.delete(k) if mappings[k] }
+      company
+    end
+
+  end
+end

data/lib/tfso/helpers.rb

@@ -0,0 +1,26 @@
+module TFSO
+
+  module Helpers
+    def intialize_savon_client
+      @savon_client = Savon.client(wsdl: self.class::URL, convert_request_keys_to: :none)
+      if defined?(Rails) && Rails.env.development?
+        @savon_client.globals.proxy('http://localhost:8080')
+        @savon_client.globals.ssl_verify_mode(:none)
+      end
+    end
+
+    def savon_client
+      @savon_client
+    end
+
+    def session_id
+      @session_id
+    end
+
+    def session_id=(session_id)
+      @session_id = session_id
+      @cookies = [HTTPI::Cookie.new("ASP.NET_SessionId=#{@session_id}")]
+    end
+  end
+
+end

data/lib/tfso/invoice.rb

@@ -0,0 +1,111 @@
+module TFSO
+  class Invoice
+
+    include TFSO::Helpers
+
+    URL = 'https://api.24sevenoffice.com/Economy/InvoiceOrder/V001/InvoiceService.asmx?wsdl'
+
+    def initialize(auth)
+      self.session_id = auth.session_id
+      intialize_savon_client
+    end
+
+    def find(search_params)
+      response = savon_client.call(:get_invoices, message: {searchParams: search_params, invoiceReturnProperties: {string: ['OrderId', 'InvoiceId', 'CustomerId', 'OrderStatus', 'DateOrdered', 'DateInvoiced', 'PaymentTime', 'CustomerReferenceNo', 'IncludeVAT', 'YourReference', 'OrderTotalIncVat', 'OrderTotalVat', 'InvoiceTitle', 'InvoiceText', 'Paid', 'Currency', 'PaymentMethodId', 'PaymentAmount', 'TypeOfSaleId', 'Distributor', 'DistributionMethod', 'InvoiceEmailAddress']}, rowReturnProperties: {string: ['ProductId', 'VatRate', 'Price', 'Name', 'DiscountRate', 'Quantity']} }, cookies: @cookies)
+      result = response.body[:get_invoices_response][:get_invoices_result]
+      if result
+        if result[:invoice_order].class == Hash
+          [result[:invoice_order]]
+        else
+          result[:invoice_order]
+        end
+      else
+        []
+      end
+    end
+
+    def find_by_invoice_id(id)
+      if invoice = find(InvoiceIds: {int: [id]})
+        invoice.first
+      else
+        false
+      end
+    end
+
+    def find_by_order_id(id)
+      if invoice = find(OrderIds: {int: [id]})
+        invoice.first
+      else
+        false
+      end
+    end
+
+    def create(invoice, items)
+      response = savon_client.call(:save_invoices, message: {invoices: [{InvoiceOrder: transform_attributes(invoice, items) }] }, cookies: @cookies)
+      response.body[:save_invoices_response][:save_invoices_result][:invoice_order]
+    end
+
+    private
+
+    def transform_attributes(invoice, items)
+      state = case invoice[:state]
+      when :invoice
+        'Invoiced'
+      when :draft
+        'Offer'
+      else
+        'Offer'
+      end
+      invoice_info = {
+        OrderStatus: state,
+        DateOrdered: Time.zone.today.iso8601,
+        CustomerId: invoice[:customer_id],
+        CustomerName: invoice[:customer_name],
+        CustomerOrgNo: invoice[:customer_gov_no],
+        InvoiceEmailAddress: invoice[:customer_email],
+        InvoiceRows: []
+      }
+      if invoice[:currency]
+        invoice_info[:TypeOfSaleId] = -98
+        invoice_info[:Currency] = {
+          Symbol: invoice[:currency],
+          Rate: invoice[:currency_rate].to_f,
+        }
+        invoice_info[:PaymentTime] = 0
+      else
+        invoice_info[:TypeOfSaleId] = -100
+        invoice_info[:PaymentTime] = 7
+      end
+      invoice_info[:InvoiceTitle] = invoice[:title] if invoice[:title]
+      invoice_info[:InvoiceText] = invoice[:description] if invoice[:description]
+      invoice_info[:YourReference] = invoice[:order_ref]
+
+      invoice_info[:Distributor] = invoice[:distributor] if invoice[:distributor]
+      invoice_info[:DistributionMethod] = invoice[:distribution_method] if invoice[:distribution_method]
+
+      invoice[:Addresses] = {
+        Invoice: {
+          :Street => invoice[:customer_street],
+          :PostalCode => invoice[:customer_postal_code],
+          :PostalArea => invoice[:customer_city],
+          :State => invoice[:customer_state],
+          :Country => invoice[:customer_country_code]
+        }
+      }
+      if items.any?
+        invoiceRows = []
+        items.each {|item|
+          invoiceRows << {
+            ProductId: item[:product_id],
+            Name: item[:description],
+            Price: item[:price].to_f,
+            Quantity: item[:quantity].to_f
+          }
+        }
+        invoice_info[:InvoiceRows] = { :InvoiceRow => invoiceRows }
+      end
+      invoice_info
+    end
+
+  end
+end

data/lib/tfso/payment.rb

@@ -0,0 +1,19 @@
+module TFSO
+  class Payment
+
+    include TFSO::Helpers
+
+    URL = 'https://api.24sevenoffice.com/Economy/InvoiceOrder/V001/PaymentService.asmx?WSDL'
+
+    def initialize(auth)
+      self.session_id = auth.session_id
+      intialize_savon_client
+    end
+
+    def create(payment_info)
+      response = savon_client.call(:register_invoice_payment, message: {payment: payment_info }, cookies: @cookies)
+      response.body[:register_invoice_payment_response][:register_invoice_payment_result]
+    end
+
+  end
+end

data/lib/tfso/product.rb

@@ -0,0 +1,35 @@
+module TFSO
+  class Product
+
+    include TFSO::Helpers
+
+    URL = 'https://api.24sevenoffice.com/Logistics/Product/V001/ProductService.asmx?WSDL'
+
+    def initialize(auth)
+      self.session_id = auth.session_id
+      intialize_savon_client
+    end
+
+    def find(search_params)
+      response = savon_client.call(:get_products, message: {searchParams: search_params, returnProperties: {string: ['Id', 'Name', 'Price'] } }, cookies: @cookies)
+      result = response.body[:get_products_response][:get_products_result]
+      if result
+        if result[:product].class == Hash
+          [result[:product]]
+        else
+          result[:product]
+        end
+      else
+        []
+      end
+    end
+
+    def find_by_id(id)
+      if product = find(Id: id)
+        product.first
+      end
+    end
+
+
+  end
+end

data/lib/tfso/version.rb

@@ -0,0 +1,3 @@
+module TFSO
+  VERSION = "0.2.0"
+end

data/tfso.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tfso/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tfso"
+  spec.version       = TFSO::VERSION
+  spec.authors       = ["Espen Antonsen"]
+  spec.email         = ["espen@inspired.no"]
+
+  spec.summary       = %q{Ruby API Wrapper for 24SevenOffice.}
+  spec.homepage      = "https://github.com/espen/tfso"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "savon"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: tfso
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Espen Antonsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- espen@inspired.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tfso.rb
+- lib/tfso/authentication.rb
+- lib/tfso/company.rb
+- lib/tfso/helpers.rb
+- lib/tfso/invoice.rb
+- lib/tfso/payment.rb
+- lib/tfso/product.rb
+- lib/tfso/version.rb
+- tfso.gemspec
+homepage: https://github.com/espen/tfso
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby API Wrapper for 24SevenOffice.
+test_files: []