octadesk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f178e4b2cddf32c104a03bcb84f031f45ab5716791d7c0d66cd245bef284671c
+  data.tar.gz: 476ab1f9e1e86ef212cac227b2a5228ae25b56e283de0a20430ee56f433096f8
+SHA512:
+  metadata.gz: fe28f1fe3967d7074e80206bcab785e7215f2c6a86d80cb828f0ffc1e243bac4cf373f27a2dce8b7d73a467f65da60f11f23f1e6c2c51b0950094b578fcf9113
+  data.tar.gz: ed003e764bb56c59ca0ad4f3f03b7ee84b4fa2e6a81a9b155be011de40bd86d345eedc1a8b2597816a9cceed4d4a2ebd21179bbf257f9b3dc31a3ab78ab3ef19

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in octadesk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    octadesk (0.1.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    netrc (0.11.0)
+    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)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  octadesk!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Octadesk
+
+Octadesk gem implements interface to Oficial Octadesk API.
+
+## Requirements
+
+You need to account in Octadesk and create API Token, oficial docummentation:
+https://help.octadesk.com/kb/article/como-trabalhar-com-a-api-da-octadesk
+
+Rest Client is used to perform all API calls.
+
+## Installation
+
+```ruby
+gem 'octadesk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octadesk
+
+## Getting started
+
+First need to instance the API:
+
+    api = Octadesk::Api.new({
+        user_email: 'OCTA_USER_EMAIL',
+        api_token: 'OCTA_API_TOKEN'
+      })
+
+## Methods
+
+##### Generics
+
+
+    * api.get_request("/API_PATH", params={}, headers={})
+      -> Returns get from Octa API.
+      -> Example: @api.get_request("/persons?email=custumer@email.com")
+
+    * api.post_request("/API_PATH", params={}, headers={})
+      -> Returns post from Octa API.
+
+    * api.put_request("/API_PATH", params={}, headers={})
+      -> Returns put from Octa API.
+
+    * api.patch_request("/API_PATH", params={}, headers={})
+      -> Returns patch from Octa API.
+
+    * api.head_request("/API_PATH", params={}, headers={})
+      -> Returns head from Octa API.
+
+    * api.delete_request("/API_PATH", params={}, headers={})
+      -> Returns delete from Octa API.
+
+## Contributing / Problems?
+
+If you have encountered any problem, difficulty or bug, please start by opening a issue.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/douglaslaraa/octadesk. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "octadesk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/octadesk.rb

@@ -0,0 +1,168 @@
+require "octadesk/version"
+require "rest-client"
+require 'ostruct'
+require 'json'
+
+module Octadesk
+  class Api
+    attr_accessor :user_token
+
+    # Aqui nós recebemos a chave da Api quando o usuário inicializa a nossa classe
+    def initialize(args={})
+      @user_email = args[:user_email]
+      @api_token = args[:api_token]
+
+      raise ArgumentError if (args[:user_email] == nil or args[:user_email] == "") and (args[:api_token] == nil or args[:api_token] == "")
+
+      if args[:endpoint_url]
+        @endpoint_url = args[:endpoint_url]
+      else
+        @endpoint_url = 'https://api.octadesk.services'
+      end
+
+      @user_token = get_token(@user_email).body['token']
+      #raise ArgumentError if @token == false
+    end
+
+    def get_request(action, params={}, headers={})
+      begin
+        headers = headers.merge({
+          'accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@user_token}"
+        })
+
+        api_response_kind = headers.delete('api_response_kind')
+        api_response_kind = headers.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.get("#{@endpoint_url}#{action}", {params: params}.merge(headers)))
+      rescue => e
+        parse_response('object', e.response)
+      end
+    end
+
+    def post_request(action, params={}, headers={})
+      begin
+        headers = headers.merge({
+          'accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@user_token}"
+        })
+
+        api_response_kind = headers.delete('api_response_kind')
+        api_response_kind = headers.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.post("#{@endpoint_url}#{action}", params, headers))
+      rescue => e
+        parse_response('object', e.response)
+      end
+    end
+
+    def put_request(action, params={}, headers={})
+      begin
+        headers = headers.merge({
+          'accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@user_token}"
+        })
+
+        api_response_kind = headers.delete('api_response_kind')
+        api_response_kind = headers.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.put("#{@endpoint_url}#{action}", params, headers))
+      rescue => e
+        parse_response('object', e.response)
+      end
+    end
+
+    def patch_request(action, params={}, headers={})
+      begin
+        headers = headers.merge({
+          'accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@user_token}"
+        })
+
+        api_response_kind = headers.delete('api_response_kind')
+        api_response_kind = headers.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.patch("#{@endpoint_url}#{action}", params, headers))
+      rescue => e
+        parse_response('object', e.response)
+      end
+    end
+
+    def head_request(action, params={}, headers={})
+      begin
+        headers = headers.merge({
+          'accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@user_token}"
+        })
+
+        api_response_kind = headers.delete('api_response_kind')
+        api_response_kind = headers.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.head("#{@endpoint_url}#{action}", params))
+      rescue => e
+        parse_response('object', e.response)
+      end
+    end
+
+    def delete_request(action, params={}, headers={})
+      begin
+        headers = headers.merge({
+          'accept' => 'application/json', 
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@user_token}"
+        })
+        
+        api_response_kind = headers.delete('api_response_kind')
+        api_response_kind = headers.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.delete("#{@endpoint_url}#{action}", params))
+      rescue => e
+        parse_response('object', e.response)
+      end
+    end
+
+    private
+
+    def get_token(user_email)
+      header = { 
+        'accept' => 'application/json', 
+        'apiToken' => @api_token,
+        'username' => "#{user_email}".downcase
+      }
+      request = post_request("/login/apiToken", {}, header )
+      request
+    end
+
+    def parse_response(api_response_kind, response)
+      result = OpenStruct.new
+      result.status_code = response.code
+
+      if api_response_kind == 'object'
+        result.headers = (JSON.parse(response.headers.to_json, object_class: OpenStruct) rescue response.headers)
+        result.body = (JSON.parse(response.body, object_class: OpenStruct) rescue response.body)
+      elsif api_response_kind == 'hash'
+        result.headers = response.headers
+        result.body = (JSON.parse(response.body) rescue response.body)
+      else
+        result.headers = response.headers
+        result.body = response.body
+      end
+
+      @last_result = result
+
+      result
+    end
+    
+  end
+end

data/lib/octadesk/api.rb

@@ -0,0 +1,3 @@
+module Octadesk
+  VERSION2 = "0.1.0"
+end

data/lib/octadesk/version.rb

@@ -0,0 +1,3 @@
+module Octadesk
+  VERSION = "0.1.1"
+end

data/octadesk.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "octadesk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "octadesk"
+  spec.version       = Octadesk::VERSION
+  spec.authors       = ["Douglas Lara"]
+  spec.email         = ["douglasdelaras@gmail.com"]
+
+  spec.summary       = %q{Inteface to connect Octadesk API.}
+  spec.description   = %q{Inteface to connect Octadesk API.}
+  spec.homepage      = "https://github.com/douglaslaraa/octadesk"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/douglaslaraa/octadesk"
+    #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.add_runtime_dependency "rest-client", "~> 2.0.2"
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: octadesk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Douglas Lara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.2
+description: Inteface to connect Octadesk API.
+email:
+- douglasdelaras@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/octadesk.rb
+- lib/octadesk/api.rb
+- lib/octadesk/version.rb
+- octadesk.gemspec
+homepage: https://github.com/douglaslaraa/octadesk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/douglaslaraa/octadesk
+  source_code_uri: https://github.com/douglaslaraa/octadesk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Inteface to connect Octadesk API.
+test_files: []