sellsy-client 0.1.0

data/lib/sellsy/opportunity.rb

@@ -0,0 +1,156 @@
+require 'multi_json'
+
+module Sellsy
+  class Opportunity
+    attr_accessor :id, :name, :reference, :amount, :entity_type, :entity_id, :source_name, :funnel_name, :step_name,
+                  :comments
+
+    def create
+      command = {
+          'method' => 'Opportunities.create',
+          'params' => api_params
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+      @id = response['response']
+      response['status'] == 'success'
+    end
+
+    def update
+      command = {
+          'method' => 'Opportunities.update',
+          'params' => api_params
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+      response['status'] == 'success'
+    end
+
+    def get_funnel
+      command = {'method' => 'Opportunities.getFunnels', 'params' => {}}
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      funnel = nil
+      unless response['response'].blank? || funnel_name.blank?
+        funnel = response['response'].values.find {|f| f['name'].parameterize == funnel_name.parameterize}
+      end
+      funnel
+    end
+
+    def get_step(funnel_id)
+      command = {'method' => 'Opportunities.getStepsForFunnel', 'params' => {'funnelid' => funnel_id}}
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      step = [nil]
+      unless response['response'].blank? || step_name.blank?
+        step = response['response'].find {|s| s['label'].parameterize == step_name.parameterize}
+      end
+      step
+    end
+
+    def get_source
+      command = {'method' => 'Opportunities.getSources', 'params' => {}}
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      source = nil
+      unless response['response'].blank? || source_name.blank?
+        source = response['response'].values.find {|s| s['label'].parameterize == source_name.parameterize}
+      end
+      source
+    end
+
+    def api_params
+      funnel = get_funnel
+      step = get_step(funnel['id'])
+      source = get_source
+      if funnel && step && source
+        {
+            'opportunity' => {
+                'linkedtype' => @entity_type,
+                'linkedid' => @entity_id,
+                'ident' => @reference,
+                'sourceid' => source['id'],
+                'name' => @name,
+                'potential' => @amount,
+                'funnelid' => funnel['id'],
+                'dueDate' => (Date.today + 1.month).to_datetime.to_i,
+                'stepid' => step['id']
+            }
+        }
+      else
+        raise Exception.new("Could not find funnel, step, or source with names #{funnel_name} - #{step_name} - #{source_name}")
+      end
+    end
+
+    def self.find(id)
+      command = {
+          'method' => 'Opportunities.getOne',
+          'params' => {
+              'clientid' => id
+          }
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      opportunity = Opportunity.new
+
+      if response['response']
+        value = response['response']['opportunity']
+        opportunity.id = value['id']
+        opportunity.name = value['name']
+      end
+
+      return opportunity
+    end
+
+    def self.search(params)
+      command = {
+          'method' => 'Opportunities.getList',
+          'params' => params
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      opportunities = []
+      if response['response']
+        response['response']['result'].each do |key, value|
+          opportunity = Opportunity.new
+          opportunity.id = key
+          opportunity.status = value['status']
+          opportunity.name = value['name']
+          opportunity.ident = value['ident']
+          opportunity.signed = value['signed']
+          opportunity.linkedid = value['linkedid']
+          opportunities << opportunity
+        end
+      end
+
+      opportunities
+    end
+
+    def self.all
+      command = {
+          'method' => 'Opportunities.getList',
+          'params' => {}
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      opportunities = []
+      if response['response']
+        response['response']['result'].each do |key, value|
+          opportunity = Opportunity.new
+          opportunity.id = key
+          opportunity.status = value['status']
+          opportunity.name = value['name']
+          opportunity.ident = value['ident']
+          opportunity.signed = value['signed']
+          opportunity.linkedid = value['linkedid']
+          opportunities << opportunity
+        end
+      end
+
+      opportunities
+    end
+  end
+end

data/lib/sellsy/prospect.rb

@@ -0,0 +1,138 @@
+require 'multi_json'
+
+module Sellsy
+  class Prospect
+
+    attr_accessor :id, :title, :name, :first_name, :last_name, :structure_name, :category, :college_type, :siret,
+                  :ape, :legal_type, :role, :birth_date, :address, :postal_code, :town, :country, :telephone, :email,
+                  :website, :payment_method, :person_type, :apidae_member_id
+
+    def create
+      command = {
+          'method' => 'Prospects.create',
+          'params' => api_params
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+      @id = response['response']
+      response['status'] == 'success'
+    end
+
+    def update
+      command = {
+          'method' => 'Prospects.update',
+          'params' => api_params
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+      response['status'] == 'success'
+    end
+
+    def api_params
+      {
+          'third' => {
+              'name' => person_type == 'pp' ? @name : @structure_name,
+              'type' => person_type == 'pp' ? 'person' : 'corporation',
+              'email' => @email,
+              'web' => @website,
+              'siret' => @siret,
+              'corpType' => @legal_type,
+              'apenaf' => @ape
+          },
+          'contact' => {
+              'civil' => civil_enum(@title),
+              'name' => @last_name || @name,
+              'forename' => @first_name,
+              'email' => @email,
+              'tel' => @telephone,
+              'mobile' => @telephone,
+              'position' => @role,
+          },
+          'address' => {
+              'name' => 'adresse souscription',
+              'part1' => @address.split(/(\r\n?)/)[0],
+              'part2' => @address.split(/(\r\n?)/)[0],
+              'zip' => @postal_code,
+              'town' => @town,
+              'countrycode' => @country.upcase
+          }
+      }
+    end
+
+    def self.find(id)
+      command = {
+          'method' => 'Prospects.getOne',
+          'params' => {
+              'id' => id
+          }
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      prospect = Prospect.new
+
+      if response['response']
+        value = response['response']['client']
+        prospect.id = value['id']
+        prospect.name = value['name']
+      end
+
+      return prospect
+    end
+
+    def self.search(params)
+      command = {
+          'method' => 'Prospects.getList',
+          'params' => params
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      prospects = []
+      if response['response']
+        response['response']['result'].each do |key, value|
+          prospect = Prospect.new
+          prospect.id = key
+          prospect.name = value['fullName']
+          prospects << prospect
+        end
+      end
+
+      prospects
+    end
+
+    def self.all
+      command = {
+          'method' => 'Prospects.getList',
+          'params' => {}
+      }
+
+      response = MultiJson.load(Sellsy::Api.request command)
+
+      prospects = []
+      if response['response']
+        response['response']['result'].each do |key, value|
+          prospect = Prospect.new
+          prospect.id = key
+          prospect.name = value['fullName']
+          prospects << prospect
+        end
+      end
+
+      prospects
+    end
+
+    private
+
+    def civil_enum(val)
+      case val
+      when 'M.'
+        'man'
+      when 'Mme'
+        'woman'
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/sellsy/version.rb

@@ -0,0 +1,3 @@
+module Sellsy
+  VERSION = "0.1.0"
+end

data/sellsy-client.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/sellsy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sellsy-client"
+  spec.version       = Sellsy::VERSION
+  spec.authors       = ["Jens Stammers", "Guirec Corbel", "François Guilbert", "Jean-Baptiste Vilain"]
+  spec.email         = ["jbvilain@gmail.com"]
+
+  spec.summary       = "A Ruby gem wrapping a REST client for the Sellsy API"
+  spec.description   = "To be completed"
+  spec.homepage      = "https://github.com/hotentic/sellsy-client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "multi_json", "~> 1.11"
+  spec.add_dependency "rest-client", "~> 2.0", ">= 2.0.2"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sellsy-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jens Stammers
+- Guirec Corbel
+- François Guilbert
+- Jean-Baptiste Vilain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: To be completed
+email:
+- jbvilain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sellsy.rb
+- lib/sellsy/address.rb
+- lib/sellsy/api.rb
+- lib/sellsy/attachment.rb
+- lib/sellsy/contact.rb
+- lib/sellsy/custom_field.rb
+- lib/sellsy/customer.rb
+- lib/sellsy/document.rb
+- lib/sellsy/invoice.rb
+- lib/sellsy/opportunity.rb
+- lib/sellsy/prospect.rb
+- lib/sellsy/version.rb
+- sellsy-client.gemspec
+homepage: https://github.com/hotentic/sellsy-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem wrapping a REST client for the Sellsy API
+test_files: []