Dendreo 1.0.5 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f6acd8aec6aad15be181d8c7562c4ceff992d21e
-  data.tar.gz: 976cd232b037d758edb5e149b5e0699f4129cfbb
+SHA256:
+  metadata.gz: 80deec797bcba45bc51d99def32ab84d15796a83e07e1219b6c379702d788ee5
+  data.tar.gz: ba2118cdb3d05e7f0f6e875634eeffeb2354ed98355ef0df5326d6d1a1081b76
 SHA512:
-  metadata.gz: 67f98ad4219e4d8510d497d2c27bd764e78417bc96a655159aff17a8f5a36948c26c462b08bd6d3c05238027d9ef9e3f66b65157afce1084bb02b1798dc14b97
-  data.tar.gz: 1783a737d7be365b669e48a8f0e9d104c00594cccfb65e06532959940de67557efebc444927baf570904dc5730c650ae1ad0e4c32fbe8b808fe50cc4c346f502
+  metadata.gz: 6d28f4d2e4b3410911cc932d471b797509872bb3f8d1b1cb08dacec9187d31f43ac1a06c72069e5d20ab1f249c4a464331f32d42cdc935e5950a3ee79062c84a
+  data.tar.gz: 145b8f63c3d285a33b6c2a7c98b39e423ee1d184237ec43fc9c4e0f7dd7350c160a2c95237970c9d6b39c020959fae3c9d60c8093bf07a861c829e3a726adf8d

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
+.idea/

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/README.md

@@ -25,7 +25,7 @@ Ou installez la gem vous-même:
 Instanciez votre API.
 
 ```ruby
-  dendreo = Dendreo::API.new("https://pro.dendreo.com/masociété/api", "MaCleApi")
+  dendreo = Dendreo::API.new('https://pro.dendreo.com/masociété/api', 'MaCleApi')
 ```
 Attention à bien vérifier que votre url à bien ce format:
 
@@ -37,67 +37,94 @@ Attention à bien vérifier que votre url à bien ce format:
 
 Je vous invite à bien lire la documentation de l'api ici => https://developers.dendreo.com/
 
-La gem utilise la "method_missing", il vous suffira donc de récupérer le nom de la resource que vous souhaitez récupérer, ajouter ou modifier (hé oui c'est possible!).
+La gem utilise la 'method_missing', il vous suffira donc de récupérer le nom de la resource que vous souhaitez récupérer, ajouter ou modifier.
 
 Exemple:
 
 Il faut donc piocher le nom de la ressource tel quel est dans l'url de la requête API.
 
--Catégories de module.         => "categories_module"
--Catégories de produits        => "categories_produit"
--Modules/Produits              => "modules"
--Formateurs                    => "formateurs"
--Entreprises                   => "entreprises"
--Contacts                      => "contacts"
--Particuliers                  => "contacts" avec la variable "particulier" = 1 sinon ajout d'un contact
--Participants                  => "participants"
--Etapes                        => "etapes"
--Centres de formation          => "centres_de_formation"
--Salles de formation           => "salles_de_formation"
--Factures                      => "factures"
--Actions de formation          => "actions_de_formation"
--Créneaux                      => "creneaux"
--Inscription d'un participant  => "laps"
--Programmation d'un module     => "lams"
--Mails                         => "emails"
+- Catégories de module.         => 'categories_module'
+- Catégories de produits        => 'categories_produit'
+- Modules/Produits              => 'modules'
+- Formateurs                    => 'formateurs'
+- Entreprises                   => 'entreprises'
+- Contacts                      => 'contacts'
+- Particuliers                  => 'contacts' avec la variable 'particulier' = 1 sinon ajout d'un contact
+- Participants                  => 'participants'
+- Etapes                        => 'etapes'
+- Centres de formation          => 'centres_de_formation'
+- Salles de formation           => 'salles_de_formation'
+- Factures                      => 'factures'
+- Actions de formation          => 'actions_de_formation'
+- Créneaux                      => 'creneaux'
+- Inscription d'un participant  => 'laps'
+- Programmation d'un module     => 'lams'
+- Mails                         => 'emails'
+
+
+Arguments:
 
+```ruby
+# methode http 
+{ method: :get }
+
+# toute information qui doit passer par l'url
+{ url_data: { id: 123456 } } 
+
+# toute information que vous souhaitez modifier/créer
+{ form_data: { email: 'dendreo@test.com' } } 
+
+# exemple d'utilisation
+dendreo = Dendreo::API.new('https://pro.dendreo.com/masociété/api', 'MaCleApi') 
+
+dendreo.participants(
+  method: :post, 
+  url_data: { 
+    id_participant: 1345 
+  }, 
+  form_data: { 
+    nom: 'nouveau nom', 
+    civilite: 'M.', 
+    id_add: 2, 
+  }
+) 
+
+```
 
 Pour les participants ( GET https://pro.dendreo.com/demo/api/participants.php?)
 
 ```ruby
   # Renvoi tous les particpants
-  dendreo.participants(method: "get")
+  dendreo.participants(method: 'get')
 
   # Renvoi le particpant qui a l'id en question
-  dendreo.participants(method: "get", datas: {id_participant: 1345})
+  dendreo.participants(method: 'get', url_data: { id_participant: 1345 })
 
   # Renvoi le ou les particpants qui ont l'email en question
-  dendreo.participants(method: "get", datas: {email: "mon_email@gmail.com"})
+  dendreo.participants(method: 'get', url_data: { email: 'mon_email@gmail.com' })
 
   #Renvoi le ou les particpants qui ont le commentaire en question
-  dendreo.participants(method: "get", datas: {search: "Un joli nom ou ce que vous souhaitez id, email, commentaires etc.."})
+  dendreo.participants(method: 'get', url_data: { search: 'Un nom ou ce que vous souhaitez id, email, commentaires etc..' })
 ```
 
 Ajouter ou modifier un participant.
 
-Attention, pour modifier un participant déjà existant, il vous suffit de remplacer "id_participant" par "id" tout court et d'ajouter un "id_add" qui contiendra un id d'administrateur.
+Attention, pour modifier un participant déjà existant, il vous suffit de remplacer 'id_participant' par 'id' tout court et d'ajouter un 'id_add' qui contiendra un id d'administrateur.
 
 Faites appel au support dendreo pour plus d'informations, ils sont très réactifs equipe@dendreo.com .
 
 ```ruby
   # Créer un participant
-  dendreo.participants(method: "post", datas: {nom: "nouveau nom", prenom: "toto", civilite: "M.", email: "toto@gmail.com", id_add: 2})
+  dendreo.participants(method: 'post', form_data: { nom: 'nouveau nom', prenom: 'toto', civilite: 'M.', email: 'toto@gmail.com', id_add: 2 })
 
-  # Modifier un participant existant (Attention, bien remplacer "id" par "id_participant" et ajouter un "id_add" pour
+  # Modifier un participant existant (Attention, bien remplacer 'id' par 'id_participant' et ajouter un 'id_add' pour
   # s'identifier en admin sur la mise à jour.)
-  dendreo.participants(method: "post", datas: {id_participant: 1345, nom: "nouveau nom", civilite: "M.", id_add: 2})
+  dendreo.participants(method: 'post', url_data: { id_participant: 1345 }, form_data: { nom: 'nouveau nom', civilite: 'M.', id_add: 2 })
 
-  # Supprimer un participant (attention, il n'y a pas de methode "delete" sûr tous les endpoints)
-  dendreo.participants(method: "delete", datas: {id_participant: 1345})
+  # Supprimer un participant (attention, il n'y a pas de methode 'delete' sûr tous les endpoints)
+  dendreo.participants(method: 'delete', url_data: { id_participant: 1345 })
 
 ```
-Cet exemple fonctionne sur toutes les ressources sauf les "particuliers" que l'on peut créer mais pas modifier.
-
 
 ## Contribution
 

data/dendreo.gemspec

@@ -30,8 +30,9 @@ 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.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rest-client"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rest-client'
+  spec.add_development_dependency 'byebug'
 end

data/lib/dendreo.rb

@@ -1,48 +1,55 @@
-require "dendreo/version"
-require "json"
-require 'net/http'
-require "rest-client"
+# frozen_string_literal: true
+
+require 'byebug'
+require 'dendreo/version'
+require 'dendreo/requests/error'
+require 'dendreo/requests/url'
+require 'dendreo/request'
+require 'json'
+require 'rest-client'
+
 module Dendreo
   class API
-    attr_accessor :url
-    attr_accessor :api_key
+    attr_accessor :url, :api_key, :errors, :result
 
     def initialize(url, api_key)
-      @url = url #exemple = https://pro.dendreo.com/my_company/api
+      @url = url # https://pro.dendreo.com/my_company/api
       @api_key = api_key
+      @request = Request.new(base_url: @url, api_key: @api_key)
+      @errors = @request.errors
+      @result = nil
+      handle_errors
     end
 
     def method_missing(method_name, *args)
-      method_name_string = method_name.to_s
-      request_method = args.first[:method]
-      datas = args.any? ? args.first[:datas] : {}
-      base_url = "#{@url}/#{method_name_string}.php?key=#{@api_key}"
-      case request_method
-      when "get"
-        send_it(:get, "#{base_url}#{format_args_to_url(datas || {})}")
-      when "post"
-        send_it(:post, "#{base_url}", datas)
-      when "delete"
-        send_it(:delete, "#{base_url}#{format_args_to_url(datas)}")
-      else
-        raise "Méthode inconnue '#{request_method}' !"
-      end
+      @errors = []
+      @result = @request.call(
+        http_method: args.first[:method],
+        endpoint: method_name,
+        args: args.first,
+      )
+      handle_errors
+      @result
     end
 
     private
 
-    def send_it(http_method, url, options = {})
-      hsh = {url: url, method: http_method }
-      hsh.merge!(payload: options) if http_method == :post
-      response_json(RestClient::Request.execute(hsh))
-    end
+    def handle_errors
+      handle_init_errors
+      @errors += @request.errors
+      return if @errors.empty?
 
-    def format_args_to_url(args = {})
-      args.any? ? args.map{|k, v| k == args.keys.first ? "&#{k}=#{v}" : "#{k}=#{v}" }.join("&") : ""
+      raise Requests::Error.new(@errors.map(&:message).join(', '))
     end
 
-    def response_json(result)
-      JSON.parse(result == "" ? "[{}]" : result)
+    def handle_init_errors
+      errors << Requests::Error.new(
+        'Veuillez renseigner une url ex: https://pro.dendreo.com/my_company/api'
+      ) if @url.nil? or @url == ''
+
+      errors << Requests::Error.new(
+        'Veuillez renseigner une clé API'
+      ) if @api_key.nil? or @api_key == ''
     end
   end
 end

data/lib/dendreo/request.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Dendreo
+  class Request
+    attr_accessor :errors, :data
+
+    def initialize(base_url:, api_key:)
+      @url = base_url
+      @api_key = api_key
+      @errors = []
+      @form_data = nil
+      @url_data = nil
+      @request = nil
+    end
+
+    def call(http_method:, endpoint:, args: {})
+      update_data(args)
+      handle_call_errors(http_method, endpoint, args)
+      execute(
+        http_method,
+        Requests::Url.new(@url, endpoint, @url_data, @api_key).complete_url,
+        @form_data,
+      )
+    end
+
+    private
+
+    def update_data(args)
+      @form_data = args[:form_data] || []
+      @url_data = args[:url_data] || []
+    end
+
+    def execute(http_method, url, options = {})
+      @request = RestClient::Request.execute(
+        url: url,
+        method: http_method,
+        payload: options,
+      )
+      response_json(@request)
+    rescue SocketError => e
+      errors << Requests::Error.new('Veuillez renseigner une url ex: https://pro.dendreo.com/my_company/api')
+    rescue RestClient::ExceptionWithResponse => e
+      response_json(e.response)
+    end
+
+    def response_json(result)
+      JSON.parse(result == '' ? '[{}]' : result)
+    end
+
+    def handle_call_errors(http_method, endpoint, args = {})
+      errors << Requests::Error.new(
+        'Veuillez renseigner une méthode de requête ex: :post, :get, :delete'
+      ) unless http_method
+
+      errors << Requests::Error.new(
+        'Veuillez renseigner une méthode de requête ex: :participants'
+      ) unless endpoint
+
+      errors << Requests::Error.new(
+        'La data est vide sur une requête :post'
+      ) if http_method == :post && args[:form_data].empty?
+    end
+  end
+end

data/lib/dendreo/requests/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Dendreo
+  module Requests
+    class Error < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/dendreo/requests/url.rb

@@ -0,0 +1,35 @@
+# frozen_String_literal: true
+
+module Dendreo
+  module Requests
+    class Url
+      attr_reader :complete_url
+
+      def initialize(url, endpoint, url_data, api_key)
+        @endpoint = endpoint.to_s
+        @url_data = url_data
+        @url = url
+        @api_key = api_key
+        @complete_url = build_complete_url
+      end
+
+      private
+
+      def build_data_url
+        @url_data.map do |k, v|
+          "#{k}=#{v}"
+        end.join('&')
+      end
+
+      def build_url
+        return '' if @url_data&.empty?
+
+        build_data_url
+      end
+
+      def build_complete_url
+        "#{@url}/#{@endpoint}.php?key=#{@api_key}&#{build_url}"
+      end
+    end
+  end
+end

data/lib/dendreo/version.rb

@@ -1,3 +1,3 @@
 module Dendreo
-  VERSION = "1.0.5"
+  VERSION = '1.1.1'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: Dendreo
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.1
 platform: ruby
 authors:
 - ronan louarn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        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: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 description: Simple gem for Dendreo CRM API
 email:
 - ronan33720@hotmail.Com
@@ -75,12 +89,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Dendreo-1.0.0.gem
 - Dendreo-1.0.1.gem
 - Dendreo-1.0.2.gem
 - Dendreo-1.0.3.gem
 - Dendreo-1.0.4.gem
+- Dendreo-1.1.0.gem
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -89,6 +105,9 @@ files:
 - bin/setup
 - dendreo.gemspec
 - lib/dendreo.rb
+- lib/dendreo/request.rb
+- lib/dendreo/requests/error.rb
+- lib/dendreo/requests/url.rb
 - lib/dendreo/version.rb
 homepage: http://lr-dev.fr
 licenses:
@@ -110,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple gem for Dendreo CRM API