Dendreo 1.0.2 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be5be5e5e6ceb74626673f5a5a3fb76a3b34611f
-  data.tar.gz: 92e9cfbbee2d84f649753ae66bcb313064b22ed4
+SHA256:
+  metadata.gz: d5e251ec6787004223c11a9f86927755a51e33e1593347d2fc836cff2b357904
+  data.tar.gz: 708399f2691f945b04c9f37956525d8d1ed2d6b40f00ab38e81d525938628464
 SHA512:
-  metadata.gz: ffee2de89031124dbbb9af5917a5691f3c5d70d4f64f0967eeb8bc34447e46f8697972a16e512d8645fc271a1a329161276ed434048d344d6e15fd3e152066e1
-  data.tar.gz: eb2400411556691be6f9f1ec837ed94b3d577aa51f33c7fc20a7f8895695d4313871909c5e72982db78b23819e6f36c8834562aa686665cec5834f2bd6da5908
+  metadata.gz: 371b50ebfe3db73d280bf4637874719572b75006633c699a2198fef68e66d502ddbdee5e988d417597fda4ff9dcef97270fdc7192fc0c47deaf5926c17927b61
+  data.tar.gz: c939bc7d33ddfdea8ea83dace82ec9f2eee86469bc1b02aa012700a1ff21fbae41253bac2288a1039f092d3767480b1b842660f86f04caba8c893621eefc222a

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

@@ -8,7 +8,7 @@ Gem pour l'API du CRM Dendreo.
 Ajoutez cette ligne à votre Gemfile:
 
 ```ruby
-gem 'dendreo'
+gem 'Dendreo'
 ```
 
 Bien entendu:
@@ -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,70 +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.
 
-Je porte votre attention sur le fait que si vous modifiez un utilisateur il faudra re-rentrer la totalité des données, même si elles étaient déjà existantes auparavant, sinon il ne les gardera pas. Vous pouvez donc utiliser la méthode get avec l'id en question pour récupérer les informations avant de faire vôtre modification.
-
-L'API est faite comme cela. Ceci n'est pas encore spécifié dans la documentation.
 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' sur 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&.dig(: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).uniq.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,70 @@
+# 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)
+      execute(
+        http_method,
+        endpoint,
+        Requests::Url.new(@url, endpoint, @url_data, @api_key).complete_url,
+        @form_data,
+      )
+    end
+
+    private
+
+    def update_data(args)
+      @form_data = args&.dig(:form_data) || []
+      @url_data = args&.dig(:url_data) || []
+    end
+
+    def execute(http_method, endpoint, 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
+      return response_json(e.response) if e.http_headers[:content_type] == 'application/json'
+
+      e.to_json
+    rescue => _e
+      handle_call_errors(http_method, endpoint)
+    end
+
+    def response_json(result)
+      JSON.parse(result == '' ? '[{}]' : result)
+    end
+
+    def handle_call_errors(http_method, endpoint)
+      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
+      return unless http_method == :post
+
+      errors << Requests::Error.new(
+        'La data à mettre à jour (form_data:) est manquante sur une requête :post'
+      ) if @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.2"
+  VERSION = '1.1.2'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: Dendreo
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.2
 platform: ruby
 authors:
 - ronan louarn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-11 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,9 +89,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
-- Dendreo-1.0.0.gem
-- Dendreo-1.0.1.gem
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,6 +99,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:
@@ -107,8 +123,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