economic-rest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd65880ff0fbfa02445672cd4352802a5e157193
-  data.tar.gz: afaf4212c16e263681cc93f59bca3b0ba069b7ff
+  metadata.gz: a583a4c00f68b2bd538c7245d7a36505fe49d3a8
+  data.tar.gz: fc97557df7f768a0e1ea2cd68d6e6d7a53ba274e
 SHA512:
-  metadata.gz: 39de349d00f5eb3a31e794f6679d118aa460f00a6d0e5367cfe1295efab6ced17762fc90639b4cc5e74ef77e159b10ee1c7270be523b16165db84481b93ceae0
-  data.tar.gz: 727091c95d96385175069e9c3639e5f6f0bc517b30287d3ac39c66481d2f5b7e261a6d042469575f7ee8fab9ec7f637802c6e3c7093867662c7f97f56fe7c718
+  metadata.gz: ee6f2b2949418ed8cbe3b176e88a60780133e8efa571f24418d4740d3c4d29b95e4bbcf0566b3014f439dea67a16584053dedf8cbde613ce77642870fe867747
+  data.tar.gz: 593d9e1a4cf8a4d393cf51a12f5bf9598fc28f315578476b91f6f1c88d835e4afc2ff849e5a1dd1e870650b75bee09b4b3c358a8aec10fdd0d9f8baf916429e7

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:bitbucket) { |repo_name| 'https://bitbucket.org/traels/economic-rest
 
 # Specify your gem's dependencies in economic-rest.gemspec
 gemspec
+
+gem "webmock", "~> 3.5"

data/Gemfile.lock

@@ -7,8 +7,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.8)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     m (1.5.1)
@@ -20,14 +25,20 @@ GEM
     mime-types-data (3.2018.0812)
     minitest (5.11.3)
     netrc (0.11.0)
+    public_suffix (3.0.3)
     rake (10.5.0)
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
+    safe_yaml (1.0.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
@@ -38,6 +49,7 @@ DEPENDENCIES
   m
   minitest (~> 5.0)
   rake (~> 10.0)
+  webmock (~> 3.5)
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -25,7 +25,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+require 'economic/rest'
+
+Economic::Demo.hello
 
 ## Development
 

data/lib/economic/base.rb

@@ -0,0 +1,87 @@
+module Economic
+  class Base
+    def initialize(hash)
+      values_based_on_hash(hash)
+    end
+
+    def self.attributes
+      @attributes
+    end
+
+    def self.add_attribute(name)
+      (@attributes ||= []).push(name)
+    end
+
+    def self.field(name, id: false)
+      economic_cased_attibute_name = name.to_s
+      attr_accessor economic_cased_attibute_name
+      alias_method snake_case(economic_cased_attibute_name), economic_cased_attibute_name
+      alias_method "#{snake_case(economic_cased_attibute_name)}=", "#{economic_cased_attibute_name}="
+      alias_method 'id_key', economic_cased_attibute_name if id
+      add_attribute economic_cased_attibute_name
+    end
+
+    def values_based_on_hash(hash)
+      Hash.class_eval { include ExtraMethods }
+      @internal_hash = hash
+      @internal_hash.each do |k, v|
+        k = k.to_s
+        if self.class.attributes.include? k
+          if v.class == Hash
+            v.keys.count.times do |i|
+              v.alias!(Base.snake_case(v.keys[i]), v.keys[i])
+            end
+          end
+          send("#{k}=", v)
+        else
+          warn "unassigned k #{k} in #{self.class.name}" unless %w[layout self soap metaData].include? k
+        end
+      end
+    end
+
+    def to_h
+      self.class.attributes.each do |attribute|
+        @internal_hash[attribute.to_sym] = send(attribute) unless send(attribute).nil?
+      end
+      @internal_hash
+    end
+
+    def dirty?
+      self.class.attributes.each do |attribute|
+        return true unless send(attribute) == @internal_hash[attribute]
+      end
+      false
+    end
+
+    def save
+      if dirty?
+        response = repo.save(self)
+        values_based_on_hash(JSON.parse(response.body))
+      end
+    end
+
+    def self.snake_case(camel_cased)
+      camel_cased.to_s.gsub(/::/, '/')
+                 .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                 .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                 .tr('-', '_')
+                 .downcase
+    end
+
+    def self.low_camel_case(snake_cased)
+      camel = snake_cased.split('_').collect(&:capitalize).join
+      camel[0, 1].downcase + camel[1..-1]
+    end
+
+    def repo
+      Object.const_get("#{self.class}Repo")
+    end
+  end
+end
+
+module ExtraMethods
+  def alias!(newkey, oldkey)
+    self[newkey] = self[oldkey] if self.has_key?(oldkey)
+    self
+  end
+end

data/lib/economic/base_repo.rb

@@ -0,0 +1,82 @@
+require 'rest-client'
+require 'json'
+require 'economic/session'
+
+module Economic
+  class BaseRepo
+    URL = 'https://restapi.e-conomic.com/'.freeze
+    class << self
+      def headers
+        { 'X-AppSecretToken': Session.app_secret_token, 'X-AgreementGrantToken': Session.agreement_grant_token, 'Content-Type': 'application/json' }
+      end
+      def fetch(endpoint:, page_or_id: nil, pageindex: 0)
+        url = ''
+        url << URL
+        url << endpoint.to_s if endpoint
+        url << if page_or_id.nil? || page_or_id.to_s.empty?
+                 "?skippages=#{pageindex}&pagesize=1000"
+               else
+                 "/#{page_or_id}"
+               end
+        response = RestClient.get(url, headers)
+        response
+      end
+
+      def save(model)
+        url = ''
+        url << URL
+        url << endpoint_name.to_s if endpoint_name
+        url << "/#{model.id_key}"
+        if model.id_key
+          response = RestClient.put(url, model.to_h.to_json, headers)
+        else
+          response = RestClient.post(url, model.to_h.to_json, headers)
+        end
+        response
+      end
+
+      def all
+        pagination = {}
+        pageindex = 0
+        entries = []
+
+        # Loop until last page, last page does not have a 'nextPage'
+        while pagination['nextPage'] || pageindex.zero?
+          response = fetch(endpoint: endpoint_name, pageindex: pageindex)
+
+          hash = JSON.parse(response.body)
+          hash['collection'].each do |entry_hash|
+            entries.push model.new(entry_hash)
+          end
+
+          pagination = hash['pagination']
+          pageindex += 1
+        end
+        entries
+      end
+
+      def find(entry_number)
+        response = fetch(endpoint: endpoint_name, page_or_id: entry_number)
+        entry_hash = JSON.parse(response.body)
+        model.new(entry_hash)
+      end
+
+      def model
+        scopes = name.split('::')
+        scopes[1] = scopes[1][0...-1] if scopes.count == 3
+        Object.const_get("#{scopes[0]}::#{scopes[1].sub('Repo', '')}")
+      end
+
+      def endpoint_name
+        end_p = name.sub('Economic::', '')
+        if end_p.include?('::')
+          end_p = end_p.gsub('Repo', '')
+          end_p = end_p.gsub('::', '/')
+        else
+          end_p = end_p.gsub('Repo', 's')
+        end
+        end_p.downcase
+      end
+    end
+  end
+end

data/lib/economic/customer.rb

@@ -0,0 +1,39 @@
+module Economic
+  class Customer < Base
+    field :address
+    field :balance
+    field :barred
+    field :city
+    field :contacts
+    field :corporateIdentificationNumber
+    field :country
+    field :creditLimit
+    field :currency
+    field :customerNumber, id: true
+    field :deliveryLocations
+    field :dueAmount
+    field :ean
+    field :email
+    field :lastUpdated
+    field :name
+    field :mobilePhone
+    field :pNumber
+    field :publicEntryNumber
+    field :telephoneAndFaxNumber
+    field :vatNumber
+    field :website
+    field :zip
+
+    field :attention
+    field :customerContact
+    field :customerGroup
+    field :defaultDeliveryLocation
+    field :invoices
+    field :layout
+    field :paymentTerms
+    field :salesPerson
+    field :templates
+    field :totals
+    field :vatZone
+  end
+end

data/lib/economic/customer_repo.rb

@@ -0,0 +1,4 @@
+module Economic
+  class CustomerRepo < Economic::BaseRepo
+  end
+end

data/lib/economic/order.rb

@@ -0,0 +1,30 @@
+module Economic
+  class Order < Base
+    field :attachment
+    field :costPriceInBaseCurrency
+    field :currency
+    field :date
+    field :dueDate
+    field :exchangeRate
+    field :grossAmount
+    field :grossAmountInBaseCurrency
+    field :lines
+    field :marginInBaseCurrency
+    field :marginPercentage
+    field :netAmount
+    field :netAmountInBaseCurrency
+    field :orderNumber, id: true
+    field :roundingAmount
+    field :vatAmount
+
+    field :customer
+    field :delivery
+    field :notes
+    field :paymentTerms
+    field :pdf
+    field :project
+    field :recipient
+    field :references
+    field :templates
+  end
+end

data/lib/economic/orders/archived_repo.rb

@@ -0,0 +1,6 @@
+module Economic
+  module Orders
+    class ArchivedRepo < Economic::Orders::Repo
+    end
+  end
+end

data/lib/economic/orders/drafts_repo.rb

@@ -0,0 +1,14 @@
+module Economic
+  module Orders
+    class DraftsRepo < Economic::Orders::Repo
+      def self.send(model)
+        url = ''
+        url << URL
+        url << '/orders'
+        url << '/sent'
+        response = RestClient.post(url, model.to_h.to_json, headers)
+        response
+      end
+    end
+  end
+end

data/lib/economic/orders/repo.rb

@@ -0,0 +1,6 @@
+module Economic
+  module Orders
+    class Repo < Economic::BaseRepo
+    end
+  end
+end

data/lib/economic/orders/sent_repo.rb

@@ -0,0 +1,14 @@
+module Economic
+  module Orders
+    class SentRepo < Economic::Orders::Repo
+      def self.send(model)
+        url = ''
+        url << URL
+        url << '/orders'
+        url << '/drafts'
+        response = RestClient.post(url, model.to_h.to_json, headers)
+        response
+      end
+    end
+  end
+end

data/lib/economic/product.rb

@@ -0,0 +1,20 @@
+module Economic
+  class Product < Base
+    field :barCode
+    field :barred
+    field :costPrice
+    field :description
+    field :lastUpdated
+    field :name
+    field :productNumber, id: true
+    field :recommendedPrice
+    field :salesPrice
+
+    field :departmentalDistribution
+    field :inventory
+    field :invoices
+    field :pricing
+    field :productGroup
+    field :unit
+  end
+end

data/lib/economic/product_repo.rb

@@ -0,0 +1,4 @@
+module Economic
+  class ProductRepo < Economic::BaseRepo
+  end
+end

data/lib/economic/rest.rb

@@ -1,15 +1,26 @@
 require 'economic/rest/version'
 require 'rest-client'
 
+require 'economic/base_repo'
+require 'economic/base'
+require 'economic/customer_repo'
+require 'economic/customer'
+require 'economic/product_repo'
+require 'economic/product'
+
+require 'economic/orders/repo'
+require 'economic/order'
+require 'economic/orders/archived_repo'
+require 'economic/orders/drafts_repo'
+require 'economic/orders/sent_repo'
+
 module Economic
-  module Rest
-    class Demo
-      def self.hello
-        RestClient.get('https://restapi.e-conomic.com/',
-                       'X-AppSecretToken': 'Demo',
-                       'X-AgreementGrantToken': 'Demo',
-                       'Content-Type': 'application/json')
-      end
+  class Demo
+    def self.hello
+      RestClient.get('https://restapi.e-conomic.com/',
+                     'X-AppSecretToken': 'Demo',
+                     'X-AgreementGrantToken': 'Demo',
+                     'Content-Type': 'application/json')
     end
   end
 end

data/lib/economic/rest/version.rb

@@ -1,5 +1,5 @@
 module Economic
   module Rest
-    VERSION = '0.0.1'.freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/lib/economic/session.rb

@@ -0,0 +1,22 @@
+module Economic
+  # The Economic::Session contains details and behaviors for a current
+  # connection to the API endpoint.
+  class Session
+    def self.authentication(private_app_id, access_id)
+      @private_app_id = private_app_id
+      @access_id = access_id
+    end
+
+    def self.app_secret_token
+      raise ArgumentError, 'Authentication tokens not set, Call Session.authentication' if @private_app_id.nil?
+
+      @private_app_id
+    end
+
+    def self.agreement_grant_token
+      raise ArgumentError, 'Authentication tokens not set, Call Session.authentication' if @access_id.nil?
+
+      @access_id
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: economic-rest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Klogborg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,8 +97,20 @@ files:
 - bin/console
 - bin/setup
 - economic-rest.gemspec
+- lib/economic/base.rb
+- lib/economic/base_repo.rb
+- lib/economic/customer.rb
+- lib/economic/customer_repo.rb
+- lib/economic/order.rb
+- lib/economic/orders/archived_repo.rb
+- lib/economic/orders/drafts_repo.rb
+- lib/economic/orders/repo.rb
+- lib/economic/orders/sent_repo.rb
+- lib/economic/product.rb
+- lib/economic/product_repo.rb
 - lib/economic/rest.rb
 - lib/economic/rest/version.rb
+- lib/economic/session.rb
 homepage: https://bitbucket.org/traels/economic-rest
 licenses:
 - MIT