suitecrm-ruby 1.0.0

data/lib/suitecrm/api_exception.rb

@@ -0,0 +1,7 @@
+class SuiteCRM::ApiException < StandardError
+  def initialize(e = nil)
+    puts "API error: #{e.inspect}"
+    super e
+    set_backtrace e.backtrace if e
+  end
+end

data/lib/suitecrm/configuration.rb

@@ -0,0 +1,17 @@
+module SuiteCRM
+  class Configuration
+    attr_accessor :client_id
+    attr_accessor :client_secret
+    attr_accessor :api_url
+    attr_accessor :token_url
+    attr_accessor :version
+
+    def initialize
+      @client_id = nil
+      @client_secret = nil
+      @api_url = nil
+      @token_url = nil
+      @version = "V8"
+    end
+  end
+end

data/lib/suitecrm/connection.rb

@@ -0,0 +1,109 @@
+require "openssl"
+require "faraday"
+require "json"
+require "jwt"
+
+class SuiteCRM::Connection
+  class << self
+    def post(endpoint, params)
+      begin
+        response = connection.post do |req|
+          req.url endpoint
+          req.headers["Content-Type"] = "application/json"
+          req.body = params.to_json
+        end
+      rescue => e
+        raise SuiteCRM::ApiException.new(e)
+      end
+      JSON.parse(response.body)
+    end
+
+    def get(endpoint, params)
+      begin
+        response = connection.get do |req|
+          req.url endpoint
+          req.headers["Content-Type"] = "application/json"
+          req.body = params.to_json
+        end
+      rescue => e
+        raise SuiteCRM::ApiException.new(e)
+      end
+      JSON.parse(response.body)
+    end
+
+    def patch(endpoint, params)
+      begin
+        response = connection.patch do |req|
+          req.url endpoint
+          req.headers["Content-Type"] = "application/json"
+          req.body = params.to_json
+        end
+      rescue => e
+        raise SuiteCRM::ApiException.new(e)
+      end
+      JSON.parse(response.body)
+    end
+
+    def delete(endpoint)
+      begin
+        response = connection.delete do |req|
+          req.url endpoint
+          req.headers["Content-Type"] = "application/json"
+        end
+      rescue => e
+        raise SuiteCRM::ApiException.new(e)
+      end
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def connection
+      set_token
+      Faraday.new(url: @api_url) do |faraday|
+        faraday.request :url_encoded
+        faraday.options.timeout = 5
+        faraday.options.open_timeout = 5
+        faraday.headers["Authorization"] = @api_token
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def set_token
+      if @api_token.nil?
+        @api_client_id = SuiteCRM.configuration.client_id
+        @api_client_secret = SuiteCRM.configuration.client_secret
+        @api_url = SuiteCRM.configuration.api_url
+        @token_url = SuiteCRM.configuration.token_url
+        @api_token = retrieve_token
+      end
+
+      ## Tests to see if token has expired
+      t = @api_token.reverse.chomp("Bearer ".reverse).reverse
+      decoded_token = JWT.decode t, nil, false
+      token_exp = decoded_token[0]["exp"]
+      leeway = 60
+      now = Time.now.to_i
+      token_window = token_exp - leeway
+      refresh_token = !(token_window > now)
+
+      if refresh_token == true
+        ## Makes a call to get a new token
+        @api_token = retrieve_token
+      end
+    end
+
+    def retrieve_token
+      response = Faraday.post(
+        @token_url,
+        {
+          grant_type: "client_credentials",
+          client_id: @api_client_id,
+          client_secret: @api_client_secret
+        }.to_json,
+        "Content-Type" => "application/json"
+      )
+      @api_token = "Bearer " + JSON.parse(response.body)["access_token"]
+    end
+  end
+end

data/lib/suitecrm/meta.rb

@@ -0,0 +1,7 @@
+class SuiteCRM::Meta
+  class << self
+    def get
+      SuiteCRM::Connection.get "meta/modules", {}
+    end
+  end
+end

data/lib/suitecrm/module.rb

@@ -0,0 +1,19 @@
+class SuiteCRM::Module
+  class << self
+    def get(name, id, params = {})
+      SuiteCRM::Connection.get "module/#{name}/#{id}", params
+    end
+
+    def create(params)
+      SuiteCRM::Connection.post "module", params
+    end
+
+    def update(params)
+      SuiteCRM::Connection.patch "module", params
+    end
+
+    def delete(name, id)
+      SuiteCRM::Connection.delete "module/#{name}/#{id}"
+    end
+  end
+end

data/lib/suitecrm/modules.rb

@@ -0,0 +1,7 @@
+class SuiteCRM::Modules
+  class << self
+    def get(name, params = {})
+      SuiteCRM::Connection.get "module/#{name}", params
+    end
+  end
+end

data/lib/suitecrm/relationship.rb

@@ -0,0 +1,15 @@
+class SuiteCRM::Relationship
+  class << self
+    def get(name, id, related)
+      SuiteCRM::Connection.get "module/#{name}/#{id}/relationships/#{related}", {}
+    end
+
+    def create(name, id, params)
+      SuiteCRM::Connection.post "module/#{name}/#{id}/relationships", params
+    end
+
+    def delete(name, id, related, related_id)
+      SuiteCRM::Connection.delete "module/#{name}/#{id}/relationships/#{related}/#{related_id}"
+    end
+  end
+end

data/lib/suitecrm/version.rb

@@ -0,0 +1,3 @@
+module SuiteCRM
+  VERSION = "1.0.0"
+end

data/suitecrm-ruby.gemspec

@@ -0,0 +1,38 @@
+require_relative "lib/suitecrm/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "suitecrm-ruby"
+  spec.version = SuiteCRM::VERSION
+  spec.authors = ["Dino Simone"]
+  spec.email = ["dino@simone.is"]
+
+  spec.summary = "Ruby client for SuiteCRM's V8 API"
+  spec.description = "Implements basic functionality needed to create and find records in SuiteCRM."
+  spec.homepage = "https://github.com/dinosimone/suitecrm-ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem"s public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem"s CHANGELOG.md URL here."
+
+  # 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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", "~> 1.5", ">= 1.5.1"
+  spec.add_runtime_dependency "mime-types", "~> 3.3", ">= 3.3.1"
+  spec.add_runtime_dependency "jwt", "~> 2.2", ">= 2.2.3"
+  spec.add_runtime_dependency "openssl", "~> 2.2"
+  spec.add_runtime_dependency "json", "~> 2.5", ">= 2.5.1"
+
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.6"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.13"
+  spec.add_development_dependency "factory_bot", "~> 4.8", ">= 4.8.2"
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: suitecrm-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dino Simone
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+description: Implements basic functionality needed to create and find records in SuiteCRM.
+email:
+- dino@simone.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/adds_relationship_to_module.yml
+- fixtures/vcr_cassettes/creates_a_module.yml
+- fixtures/vcr_cassettes/deletes_a_module.yml
+- fixtures/vcr_cassettes/deletes_module_relationship.yml
+- fixtures/vcr_cassettes/get_all_modules_of_type.yml
+- fixtures/vcr_cassettes/gets_a_specific_module.yml
+- fixtures/vcr_cassettes/gets_relationships_for_a_module.yml
+- fixtures/vcr_cassettes/updates_a_module.yml
+- lib/suitecrm-ruby.rb
+- lib/suitecrm/api_exception.rb
+- lib/suitecrm/configuration.rb
+- lib/suitecrm/connection.rb
+- lib/suitecrm/meta.rb
+- lib/suitecrm/module.rb
+- lib/suitecrm/modules.rb
+- lib/suitecrm/relationship.rb
+- lib/suitecrm/version.rb
+- suitecrm-ruby.gemspec
+homepage: https://github.com/dinosimone/suitecrm-ruby
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Ruby client for SuiteCRM's V8 API
+test_files: []