flexibee 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50e549f3e255233fc31d03f6ed94d1b5ebf9d63f
-  data.tar.gz: 04fa0d0fb1f4c6bf9ffb8f397e4cb449af8df7ec
+  metadata.gz: 23dc2151e15956e2d264d09cb63752d2d31a8d05
+  data.tar.gz: 932392faeb05668417df84fc2863d676c9c4bb7b
 SHA512:
-  metadata.gz: 9b4a504168ad797d21ff605f95da82b51eb1d669fb83a9a8b4e46b3e563265c5415371b7a2f59d91032a90ac5b981421f75e037e758100443b70c3e5e905aa13
-  data.tar.gz: 36d2dfe46c0c5de1b5c4a63c75f246a9ff77d2e0bd4475b80206220ac420a6cebd94326caa1d0dc791a6f2ebeff861acb119723ad7729d6c80241ee0a8f6c1fc
+  metadata.gz: 9b19e3cbe16941e814212560ebb78ad17508000fecc4a14eb50bf730ea9566befd3449a9ca6355a3742ab52b93674021c0ae88706b9f83f7b8ebe5f253b93a78
+  data.tar.gz: 14695ac1502b56c7dbdd0a8fc53f3c76a3e0b6a3cf7b8a2472d76936dde0e65c7bf14640ae3954ccc27d80908cd039df9ba6e4f752c4c86fe184edea9fd47de0

data/.gitignore

@@ -8,3 +8,5 @@
 /spec/reports/
 /tmp/
 .idea
+
+tags

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/README.md

@@ -1,8 +1,6 @@
-# Flexibee
+# Flexibee [![Build Status](https://travis-ci.org/danpecher/flexibee.rb.svg?branch=master)](https://travis-ci.org/danpecher/flexibee.rb)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/flexibee`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby wrapper for Flexibee JSON REST API (docs to be found [here](https://www.flexibee.eu/api/dokumentace/))
 
 ## Installation
 
@@ -22,7 +20,215 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Connection
+
+To get base client object for establishing connection do:
+
+```
+@user_id = 'USERID'
+@login = 'LOGIN'
+@password = 'PWD'
+@company = 'COMPANY'
+
+@flexibee = Flexibee::Client.new(@user_id, @login, @password, @company)
+```
+
+Then you can proceed to access data:
+
+### Company
+
+can be accessed by:
+
+```ruby
+company = @flexibee.company
+```
+
+it has attributes:
+
+```ruby
+company.info
+company.id
+company.name
+company.db_name
+company.created_at
+```
+
+
+### Invoice Types
+
+can be accessed by:
+
+```ruby
+invoice_types = @flexibee.invoice_types
+```
+
+returns array of Flexibee::InvoiceType Structs
+
+Flexibee::InvoiceType has attributes:
+
+```ruby
+invoice_types.first.id
+invoice_types.first.updated_at
+invoice_types.first.code
+invoice_types.first.name
+invoice_types.first.currency
+invoice_types.first.currency_ref
+invoice_types.first.currency_name
+```
+
+### Order Types
+
+can be accessed by:
+
+```ruby
+order_types = @flexibee.order_types
+```
+
+returns array of Flexibee::OrderType Structs
+
+Flexibee::OrderType has attributes:
+
+```ruby
+order_types.first.id
+order_types.first.updated_at
+order_types.first.code
+order_types.first.name
+order_types.first.currency
+order_types.first.currency_ref
+order_types.first.currency_name
+```
+
+### Product List
+
+can be accessed by:
+
+```ruby
+product_list = @flexibee.product_list
+```
+
+returns Flexibee::ProductList and you can call `all` to get array of Flexibee::Product objects
+
+```ruby
+all_products = product_list.all
+```
+
+to iterate through products you can pass it params `start` and `limit`
+
+```ruby
+not_all_products = product_list.all({ start: 120, limit: 100})
+```
+
+`all_products` and `not_all_products` are now arrays of products and you can iterate through Flexibee::Product objects in it, it has these attributes:
+
+```ruby
+all_products.first.id
+all_products.first.updated_at
+all_products.first.code
+all_products.first.name
+all_products.first.price_base
+all_products.first.price_no_vat
+all_products.first.price_vat
+all_products.first.stock
+all_products.first.note
+all_products.first.description
+all_products.first.ean
+all_products.first.vat
+all_products.first.client
+```
+
+you can filter by id, name and ean to ease your work using these methods on product list:
+(They return first match from your products -> Flexibee::Product)
+
+```ruby
+product_list.find_by_id(2345)
+```
+
+```ruby
+product_list.find_by_name('My fancy product Blue/Red')
+```
+
+```ruby
+product_list.find_by_ean('9343783000326')
+```
+
+
+### Tree (Categories of products - Flexibee 'strom')
+
+Hard to find, you have to use desktop app to access these (is the tree on the left hand side in desktop app once on price list)
+
+can be accessed by:
+
+```ruby
+tree = @flexibee.tree
+```
+
+returns Flexibee::Tree and you can call `all` to get array of Flexibee::Node objects
+
+```ruby
+nodes = tree.all
+```
+
+you can also access some additional custom sets of nodes for convenience:
+
+to get root node call (returns Flexibee::Node):
+```ruby
+root = tree.root
+```
+
+to access all nodes on certain level (returns array of Flexibee::Node):
+```ruby
+nodes = tree.level(3)
+```
+
+you can lookup node by id (returns array of Flexibee::Node):
+```ruby
+nodes = tree.find_by_id(34)
+```
+
+### Node
+
+to describe Flexibee::Node better (see Tree described above which is full of them)
+
+once you get node from tree (example):
+```ruby
+node = @flexibee.tree.first
+```
+
+you can access these attributes:
+```ruby
+node.id
+node.updated_at
+node.code
+node.name
+node.level
+node.order
+node.route
+node.short_description
+node.keywords
+node.description
+node.tree_ref
+node.parent_id
+node.parent_ref
+```
+
+also you can display all descendants of the node (array of Flexibee::Node):
+```ruby
+desc = node.descendants
+```
+
+or you can display parent of the node (Flexibee::Node):
+```ruby
+parent = node.parent
+```
+
+
+## TODO
+
+* raw for response (if I left out something you want to display)
+* filtering for all
+* invoices
+* sending to flexibee
+
 
 ## Development
 
@@ -38,4 +244,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/flexibee.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry'
 
   spec.add_dependency 'rest-client'
 end

data/lib/flexibee.rb

@@ -1,18 +1,12 @@
 require 'flexibee/version'
-require 'flexibee/client/company'
-require 'flexibee/client/product'
-require 'flexibee/client/invoice_type'
-require 'flexibee/client/order_type'
+require 'flexibee/company'
+require 'flexibee/product_list'
+require 'flexibee/product'
+require 'flexibee/invoice_types'
+require 'flexibee/order_types'
+require 'flexibee/tree'
+require 'flexibee/node'
 require 'flexibee/client'
 
 module Flexibee
-
-  class << self
-    def method_missing(method_name, *args, &block)
-      @client.send(method_name, *args, &block) if @client.respond_to? method_name
-
-      super
-    end
-  end
-
 end

data/lib/flexibee/client.rb

@@ -1,28 +1,83 @@
 require 'rest-client'
+require 'erb'
 
 module Flexibee
   class Client
-    include Flexibee::Client::Company
-    include Flexibee::Client::Product
-    include Flexibee::Client::InvoiceType
-    include Flexibee::Client::OrderType
-
+    ##
+    # working with base response from flexibee
+    #
+    # {
+    #   "companies" => {
+    #     "company" => {
+    #       "createDt" => "2015-10-17T18:26:39.692+02:00",
+    #       "dbNazev" => "esperia_test",
+    #       "id" => "1",
+    #       "licenseGroup" => "04fc91491a9647d451649736ad8127e2",
+    #       "nazev" => "esperia-test",
+    #       "show" => "true",
+    #       "stavEnum" => "ESTABLISHED",
+    #       "watchingChanges" => "false"
+    #     }
+    #   }
+    # }
+    ##
     def initialize(user_id, login, password, company_id)
       @user_id = user_id
       @login = login
       @password = password
       @company_id = company_id
+    end
+
+    def base_url
+      "https://#{@login}:#{@password}@#{@user_id}.flexibee.eu:5434/c/#{@company_id}"
+    end
+
+    def base_response
+      get
+    end
+
+    ##
+    # flexibee obejcts
+    ##
+    def company
+      @company ||= Company.new(base_response)
+    end
 
-      @base_url = "https://#{login}:#{password}@#{user_id}.flexibee.eu:5434/c/#{company_id}"
+    def invoice_types
+      @invoice_types = InvoiceTypes.new(self).invoice_types
     end
 
-    def get(url, params = {}, filter = nil)
+    def order_types
+      @order_types = OrderTypes.new(self).order_types
+    end
+
+    def product_list
+      @products = ProductList.new(self)
+    end
+
+    ##
+    # By default called with { detail: 'full' }, normal response does not have any usefull information in it
+    # Also to get whole list of categories default passes { limit: 0 } to get default pass { limit: 20 }
+    ##
+    def tree
+      @tree = Tree.new(self)
+    end
+
+    ##
+    # flexibee base call methods
+    ##
+    def get(route='', params = {}, filter = nil)
+      url = base_url + route
       unless filter.nil?
-        url << '/' + URI::escape("(#{filter})")
+        url << '/' + "(#{ERB::Util.url_encode(filter)})"
       end
       url << '.json'
-      JSON.parse(RestClient.get(url, params))
+      begin
+        JSON.parse(RestClient.get(url, params: params))
+      rescue RestClient::ResourceNotFound => e
+        Object.new
+      end
     end
 
   end
-end
+end

data/lib/flexibee/company.rb

@@ -0,0 +1,31 @@
+module Flexibee
+  class Company
+    ##
+    # getting custom info from company response
+    #
+    # {
+    #   "companies" => {
+    #     "company" => {
+    #       "createDt" => "2015-10-17T18:26:39.692+02:00",
+    #       "dbNazev" => "esperia_test",
+    #       "id" => "1",
+    #       "licenseGroup" => "04fc91491a9647d451649736ad8127e2",
+    #       "nazev" => "esperia-test",
+    #       "show" => "true",
+    #       "stavEnum" => "ESTABLISHED",
+    #       "watchingChanges" => "false"
+    #     }
+    #   }
+    # }
+    ##
+    attr_accessor :info, :id, :name, :db_name, :created_at
+
+    def initialize(response)
+      @info = response['companies']['company']
+      @id = response['companies']['company']['id']
+      @name = response['companies']['company']['nazev']
+      @db_name = response['companies']['company']['dbNazev']
+      @created_at = response['companies']['company']['createDt']
+    end
+  end
+end

data/lib/flexibee/invoice_types.rb

@@ -0,0 +1,23 @@
+module Flexibee
+  InvoiceType = Struct.new(:id, :updated_at, :code, :name, :currency,
+    :currency_ref, :currency_name)
+
+  class InvoiceTypes
+    def initialize(client)
+      @client = client
+    end
+
+    def invoice_types
+      find.map do |type|
+        currency = type['mena'].split(':').last
+        currency_name = type['mena@showAs'].split(':').last.strip
+        Flexibee::InvoiceType.new(type['id'], type['lastUpdate'],
+          type['kod'], type['nazev'], currency, type['mena@ref'], currency_name)
+      end
+    end
+
+    def find(filter=nil)
+      @client.get("/typ-faktury-vydane", {}, filter)['winstrom']['typ-faktury-vydane']
+    end
+  end
+end

data/lib/flexibee/node.rb

@@ -0,0 +1,65 @@
+module Flexibee
+  class Node
+    ##
+    # One node response in detail=full mode
+    #
+    # {
+    # 	id: "2",
+		#   lastUpdate: "2015-07-03T09:52:25.048+02:00",
+		#   kod: "root",
+		#   nazev: "Připojené položky",
+		#   nazevA: "",
+		#   nazevB: "",
+		#   nazevC: "",
+		#   strobr: "",
+		#   hladina: "2",
+		#   poradi: "1",
+		#   cesta: "1/1/",
+		#   kratkyPopis: "",
+		#   klicSlova: "",
+		#   popis: "",
+		#   txtNad: "",
+		#   txtPod: "",
+		#   strom: "code:STR_CEN",
+		#   strom@ref: "/c/woodies/strom-koren/1.json",
+		#   strom@showAs: "STR_CEN: Strom ceníku",
+		#   otec: "1",
+		#   otec@ref: "/c/woodies/strom/1.json",
+		#   otec@showAs: "Strom ceníku"
+    # }
+    ##
+    attr_accessor :id, :updated_at, :code, :name, :level, :order, :route, :short_description,
+      :keywords, :description, :tree_ref, :parent_id, :parent_ref, :tree
+
+    def initialize(response, tree)
+      @id = response['id'].to_i
+      @updated_at = response['lastUpdate']
+      @code = response['kod']
+      @name = response['nazev']
+      @level = response['hladina'].to_i
+      @order = response['poradi'].to_i
+      @route = response['cesta']
+      @short_description = response['kratkyPopis']
+      @keywords = response['klicSlova']
+      @description = response['popis']
+      @tree_ref = response['strom@ref']
+      @parent_id = response['otec'].to_i
+      @parent_ref = response['otec@ref']
+      @tree = tree
+    end
+
+    ##
+    # all children of the node
+    ##
+    def descendants
+      tree.children_of(id)
+    end
+
+    ##
+    # parent of the node
+    ##
+    def parent
+      tree.parent_for(parent_id).first
+    end
+  end
+end

data/lib/flexibee/order_types.rb

@@ -0,0 +1,23 @@
+module Flexibee
+  OrderType = Struct.new(:id, :updated_at, :code, :name, :currency,
+    :currency_ref, :currency_name)
+
+  class OrderTypes
+    def initialize(client)
+      @client = client
+    end
+
+    def order_types
+      find.map do |type|
+        currency = type['mena'].split(':').last
+        currency_name = type['mena@showAs'].split(':').last.strip
+        Flexibee::OrderType.new(type['id'], type['lastUpdate'],
+          type['kod'], type['nazev'], currency, type['mena@ref'], currency_name)
+      end
+    end
+
+    def find(filter=nil)
+      @client.get("/typ-objednavky-vydane", {}, filter)['winstrom']['typ-objednavky-vydane']
+    end
+  end
+end

data/lib/flexibee/product.rb

@@ -0,0 +1,51 @@
+module Flexibee
+  class Product
+    attr_accessor :id, :updated_at, :code, :name, :price_base, :price_no_vat,
+      :price_vat, :stock, :note, :description, :ean, :vat
+
+    ##
+    # Product basic response
+    #
+    # {
+    # 	"id" => "4797",
+    # 	"lastUpdate" => "2015-09-30T15:42:45.190+02:00",
+    # 	"kod" => "B0002",
+    # 	"nazev" => "Dámský zvýhodněný balíček",
+    # 	"cenaZakl" => "1361.157024",
+    # 	"cenaZaklBezDph" => "1361.157024",
+    # 	"cenaZaklVcDph" => "1646.999999",
+    #   "sumDostupMj" =>  "0.0",
+    #   "poznam" => "NENÍ FOTO",
+    #   "popis" => "",
+    #   "eanKod" => "",
+    #   "szbDph" => "21.0"
+    # }
+    ##
+    def initialize(response, client)
+      @id = response['id'].to_i
+      @updated_at = response['lastUpdate']
+      @code = response['kod']
+      @name = response['nazev']
+      @price_base = response['cenaZakl'].to_f
+      @price_no_vat = response['cenaZaklBezDph'].to_f
+      @price_vat = response['cenaZaklVcDph'].to_f
+      @stock = response['sumDostupMj'].to_f
+      @note = response['poznam']
+      @description = response['popis']
+      @ean = response['eanKod']
+      @vat = response['szbDph'].to_f
+      @client = client
+    end
+
+    # TODO test
+    def category
+      uzel_id = find_relationship ? find_relationship['uzel'] : find_relationship
+      uzel_id ? @client.tree.find_by_id(uzel_id.to_i).first : nil
+    end
+
+    # TODO test
+    def find_relationship
+      @client.get("/strom-cenik", { detail: 'full' }, "idZaznamu='#{id}'")['winstrom']['strom-cenik'][0]
+    end
+  end
+end

data/lib/flexibee/product_list.rb

@@ -0,0 +1,36 @@
+module Flexibee
+  class ProductList
+    ##
+    # By default called with { detail: 'full' }, normal response does not have any usefull information in it
+    ##
+    def initialize(client)
+      @client = client
+    end
+
+    def all(params={})
+      create_products(find(nil, params))
+    end
+
+    def find(filter=nil, params={})
+      @client.get("/cenik", params.merge({ detail: 'full' }), filter)['winstrom']['cenik']
+    end
+
+    def find_by_id(id)
+      create_products(find("id='#{id}'")).first
+    end
+
+    def find_by_name(name)
+      create_products(find("nazev='#{name}'")).first
+    end
+
+    def find_by_ean(ean)
+      create_products(find("eanKod='#{ean}'")).first
+    end
+
+    private
+
+    def create_products(response)
+      response.map { |p| Flexibee::Product.new(p, @client) }
+    end
+  end
+end

data/lib/flexibee/tree.rb

@@ -0,0 +1,41 @@
+module Flexibee
+  class Tree
+    def initialize(client)
+      @client = client
+    end
+
+    def all
+      create_nodes(find)
+    end
+
+    def find(filter=nil)
+      @client.get("/strom", { detail: 'full', limit: 0 }, filter)['winstrom']['strom']
+    end
+
+    def root
+      level.first
+    end
+
+    def level(level=1)
+      create_nodes(find("hladina='#{level}'"))
+    end
+
+    def find_by_id(id)
+      create_nodes(find("id='#{id}'"))
+    end
+
+    def children_of(node_id)
+      create_nodes(find("otec='#{node_id}'"))
+    end
+
+    def parent_for(parent_id)
+      create_nodes(find("id='#{parent_id}'"))
+    end
+
+    private
+
+    def create_nodes(response)
+      response.map{ |n| Flexibee::Node.new(n, self) }
+    end
+  end
+end

data/lib/flexibee/version.rb

@@ -1,3 +1,3 @@
 module Flexibee
-  VERSION = "0.1.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: flexibee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dan Pecher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -114,10 +128,13 @@ files:
 - flexibee.gemspec
 - lib/flexibee.rb
 - lib/flexibee/client.rb
-- lib/flexibee/client/company.rb
-- lib/flexibee/client/invoice_type.rb
-- lib/flexibee/client/order_type.rb
-- lib/flexibee/client/product.rb
+- lib/flexibee/company.rb
+- lib/flexibee/invoice_types.rb
+- lib/flexibee/node.rb
+- lib/flexibee/order_types.rb
+- lib/flexibee/product.rb
+- lib/flexibee/product_list.rb
+- lib/flexibee/tree.rb
 - lib/flexibee/version.rb
 homepage: https://github.com/danpecher/flexibee
 licenses:

data/lib/flexibee/client/company.rb

@@ -1,9 +0,0 @@
-module Flexibee
-  class Client
-    module Company
-      def company_info
-        get("#{@base_url}")['companies']['company']
-      end
-    end
-  end
-end

data/lib/flexibee/client/invoice_type.rb

@@ -1,9 +0,0 @@
-module Flexibee
-  class Client
-    module InvoiceType
-      def invoice_types(params = {}, filter = nil)
-        get("#{@base_url}/typ-faktury-vydane", params, filter)['winstrom']['typ-faktury-vydane']
-      end
-    end
-  end
-end

data/lib/flexibee/client/order_type.rb

@@ -1,9 +0,0 @@
-module Flexibee
-  class Client
-    module OrderType
-      def order_types(params = {}, filter = nil)
-        get("#{@base_url}/typ-objednavky-vydane", params, filter)['winstrom']['typ-objednavky-vydane']
-      end
-    end
-  end
-end

data/lib/flexibee/client/product.rb

@@ -1,9 +0,0 @@
-module Flexibee
-  class Client
-    module Product
-      def product_list(params = {}, filter = nil)
-        get("#{@base_url}/cenik", params, filter)['winstrom']['cenik']
-      end
-    end
-  end
-end