rdstation-ruby-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3abd8cbbff8541804f9098ccf8076025404e9fd
-  data.tar.gz: 303aed653c2a72f186bdbfc2b1dea8f56c7ff55d
+  metadata.gz: a0928853bb9ae75ec8ed56f8f532c18ddc42c205
+  data.tar.gz: 74e5de6ea1c9f33cae06f781f4979a0e674b7e1b
 SHA512:
-  metadata.gz: 752ad7a2b479d064dfc176f2299f31035a51bfff11dbf71f3bf96fd813ac840524125789a035880a613b1c77b79ca8698b0b40687afb9ef28eee4ab4da1f6807
-  data.tar.gz: 1494b26e7d0867b640e8ea4deab9e57b8fb716417a194c821a9e77f7a9ebc8bce1057910be8e10908afde16b1ab347b28add6feacbb1f8b49818adb76019aace
+  metadata.gz: a89281c0b92792ebe57eb4383dcb460aa0edc04b967a8aa283a7272fc336dd410ba4b2e0482109949cb6f27321af5566c055bd49c9e7a55efa85c995b4329ab4
+  data.tar.gz: 0703a456fd3772fa02b1026f69c6bcec1b3dfb22b34efe93ba6ce75c4bcd528feb88b2d9dba8dc97d4dccc14eaa8c9a965c59367bc0e786106b57f1e2c3f9271

data/.circleci/config.yml

@@ -0,0 +1,57 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+        
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdstation-ruby-client (1.0.1)
+    rdstation-ruby-client (1.2.0)
       httparty (~> 0.12)
 
 GEM
@@ -32,6 +32,8 @@ GEM
     rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
     safe_yaml (1.0.4)
     turn (0.9.7)
       ansi
@@ -49,6 +51,7 @@ DEPENDENCIES
   rake
   rdstation-ruby-client!
   rspec
+  rspec_junit_formatter
   turn
   webmock (~> 2.1)
 

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://circleci.com/gh/ResultadosDigitais/rdstation-ruby-client.svg?style=svg)](https://circleci.com/gh/ResultadosDigitais/rdstation-ruby-client)
+
 # RDStation Ruby Client
 
 RDstation ruby wrapper to interact with RDStation API.

data/lib/rdstation-ruby-client.rb

@@ -1,11 +1,15 @@
 require 'httparty'
 
+# API Response handler
+require 'rdstation/api_response'
+
 # API requests
 require 'rdstation/authentication'
 require 'rdstation/client'
 require 'rdstation/contacts'
 require 'rdstation/events'
 require 'rdstation/fields'
+require 'rdstation/webhooks'
 
 # Error handling
 require 'rdstation/error'

data/lib/rdstation/api_response.rb

@@ -0,0 +1,9 @@
+module RDStation
+  module ApiResponse
+    def self.build(response)
+      response_body = JSON.parse(response.body)
+      return response_body unless response_body['errors']
+      RDStation::ErrorHandler.new(response).raise_errors
+    end
+  end
+end

data/lib/rdstation/authentication.rb

@@ -35,9 +35,7 @@ module RDStation
     # or code is invalid.
     def authenticate(code)
       response = post_to_auth_endpoint(code: code)
-      parsed_body = JSON.parse(response.body)
-      return parsed_body unless parsed_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     #
@@ -46,9 +44,7 @@ module RDStation
     #
     def update_access_token(refresh_token)
       response = post_to_auth_endpoint(refresh_token: refresh_token)
-      parsed_body = JSON.parse(response.body)
-      return parsed_body unless parsed_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     private

data/lib/rdstation/contacts.rb

@@ -14,16 +14,12 @@ module RDStation
     #
     def by_uuid(uuid)
       response = self.class.get(base_url(uuid), headers: required_headers)
-      response_body = JSON.parse(response.body)
-      return response_body unless response_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     def by_email(email)
       response = self.class.get(base_url("email:#{email}"), headers: required_headers)
-      response_body = JSON.parse(response.body)
-      return response_body unless response_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     # The Contact hash may contain the following parameters:
@@ -39,9 +35,7 @@ module RDStation
     # :tags
     def update(uuid, contact_hash)
       response = self.class.patch(base_url(uuid), :body => contact_hash.to_json, :headers => required_headers)
-      response_body = JSON.parse(response.body)
-      return response_body unless response_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     #
@@ -55,9 +49,7 @@ module RDStation
     def upsert(identifier, identifier_value, contact_hash)
       path = "#{identifier}:#{identifier_value}"
       response = self.class.patch(base_url(path), body: contact_hash.to_json, headers: required_headers)
-      response_body = JSON.parse(response.body)
-      return response_body unless response_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     private

data/lib/rdstation/events.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
 module RDStation
-  # More info: https://developers.rdstation.com/pt-BR/reference/contacts
   class Events
     include HTTParty
 

data/lib/rdstation/fields.rb

@@ -12,9 +12,7 @@ module RDStation
 
     def all
       response = self.class.get(BASE_URL, headers: required_headers)
-      response_body = JSON.parse(response.body)
-      return response_body unless response_body['errors']
-      RDStation::ErrorHandler.new(response).raise_errors
+      ApiResponse.build(response)
     end
 
     private

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/rdstation/webhooks.rb

@@ -0,0 +1,49 @@
+module RDStation
+  class Webhooks
+    include HTTParty
+
+    def initialize(auth_token)
+      @auth_token = auth_token
+    end
+
+    def all
+      response = self.class.get(base_url, headers: required_headers)
+      ApiResponse.build(response)
+    end
+
+    def by_uuid(uuid)
+      response = self.class.get(base_url(uuid), headers: required_headers)
+      ApiResponse.build(response)
+    end
+
+    def create(payload)
+      response = self.class.post(base_url, headers: required_headers, body: payload.to_json)
+      ApiResponse.build(response)
+    end
+
+    def update(uuid, payload)
+      response = self.class.put(base_url(uuid), headers: required_headers, body: payload.to_json)
+      ApiResponse.build(response)
+    end
+
+    def delete(uuid)
+      response = self.class.delete(base_url(uuid), headers: required_headers)
+      return webhook_deleted_message unless response.body
+      RDStation::ErrorHandler.new(response).raise_errors
+    end
+
+    private
+
+    def webhook_deleted_message
+      { message: 'Webhook deleted successfuly!' }
+    end
+
+    def base_url(path = '')
+      "https://api.rd.services/integrations/webhooks/#{path}"
+    end
+
+    def required_headers
+      { 'Authorization' => "Bearer #{@auth_token}", 'Content-Type' => 'application/json' }
+    end
+  end
+end

data/rdstation-ruby-client.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock', '~> 2.1'
   spec.add_development_dependency 'turn'
+  spec.add_development_dependency 'rspec_junit_formatter'
 
   spec.add_dependency "httparty", "~> 0.12"
 end

data/spec/lib/rdstation/webhooks_spec.rb

@@ -0,0 +1,243 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::Webhooks do
+  let(:webhooks_client) { described_class.new('auth_token') }
+  let(:webhooks_endpoint) { 'https://api.rd.services/integrations/webhooks/' }
+
+  let(:headers) do
+    {
+      'Authorization' => 'Bearer auth_token',
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  let(:error_handler) do
+    instance_double(RDStation::ErrorHandler, raise_errors: 'mock raised errors')
+  end
+
+  before do
+    allow(RDStation::ErrorHandler).to receive(:new).and_return(error_handler)
+  end
+
+  describe '#all' do
+    context 'when the request is successful' do
+      let(:webhooks) do
+        {
+          'webhooks' => [
+            {
+              'uuid' => '5408c5a3-4711-4f2e-8d0b-13407a3e30f3',
+              'event_type' => 'WEBHOOK.CONVERTED',
+              'entity_type' => 'CONTACT',
+              'url' => 'http =>//my-url.com',
+              'http_method' => 'POST',
+              'include_relations' => []
+            },
+            {
+              'uuid' => '642d985c-487c-4c53-b9de-2c1223841cae',
+              'event_type' => 'WEBHOOK.MARKED_OPPORTUNITY',
+              'entity_type' => 'CONTACT',
+              'url' => 'http://my-url.com',
+              'http_method' => 'POST',
+              'include_relations' => %w[COMPANY CONTACT_FUNNEL]
+            }
+          ]
+        }
+      end
+
+      before do
+        stub_request(:get, webhooks_endpoint)
+          .with(headers: headers)
+          .to_return(status: 200, body: webhooks.to_json)
+      end
+
+      it 'returns all webhooks' do
+        response = webhooks_client.all
+        expect(response).to eq(webhooks)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, webhooks_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_errors on error handler' do
+        webhooks_client.all
+        expect(error_handler).to have_received(:raise_errors)
+      end
+    end
+  end
+
+  describe '#by_uuid' do
+    let(:uuid) { '5408c5a3-4711-4f2e-8d0b-13407a3e30f3' }
+    let(:webhooks_endpoint_by_uuid) { webhooks_endpoint + uuid }
+
+    context 'when the request is successful' do
+      let(:webhook) do
+        {
+          'uuid' => uuid,
+          'event_type' => 'WEBHOOK.CONVERTED',
+          'entity_type' => 'CONTACT',
+          'url' => 'http =>//my-url.com',
+          'http_method' => 'POST',
+          'include_relations' => []
+        }
+      end
+
+      before do
+        stub_request(:get, webhooks_endpoint_by_uuid)
+          .with(headers: headers)
+          .to_return(status: 200, body: webhook.to_json)
+      end
+
+      it 'returns the webhook' do
+        response = webhooks_client.by_uuid(uuid)
+        expect(response).to eq(webhook)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:get, webhooks_endpoint_by_uuid)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_errors on error handler' do
+        webhooks_client.by_uuid(uuid)
+        expect(error_handler).to have_received(:raise_errors)
+      end
+    end
+  end
+
+  describe '#create' do
+    let(:payload) do
+      {
+        'entity_type' =>  'CONTACT',
+        'event_type' =>  'WEBHOOK.CONVERTED',
+        'url' =>  'http://my-url.com',
+        'http_method' => 'POST',
+        'include_relations' => %w[COMPANY CONTACT_FUNNEL]
+      }
+    end
+
+    context 'when the request is successful' do
+      let(:webhook) do
+        {
+          'uuid' => '5408c5a3-4711-4f2e-8d0b-13407a3e30f3',
+          'event_type' => 'WEBHOOK.CONVERTED',
+          'entity_type' => 'CONTACT',
+          'url' => 'http =>//my-url.com',
+          'http_method' => 'POST',
+          'include_relations' => %w[COMPANY CONTACT_FUNNEL]
+        }
+      end
+
+      before do
+        stub_request(:post, webhooks_endpoint)
+          .with(headers: headers, body: payload.to_json)
+          .to_return(status: 200, body: webhook.to_json)
+      end
+
+      it 'returns the webhook' do
+        response = webhooks_client.create(payload)
+        expect(response).to eq(webhook)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:post, webhooks_endpoint)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_errors on error handler' do
+        webhooks_client.create(payload)
+        expect(error_handler).to have_received(:raise_errors)
+      end
+    end
+  end
+
+  describe '#update' do
+    let(:uuid) { '5408c5a3-4711-4f2e-8d0b-13407a3e30f3' }
+    let(:webhooks_endpoint_by_uuid) { webhooks_endpoint + uuid }
+    let(:new_payload) do
+      {
+        'entity_type' =>  'CONTACT',
+        'event_type' =>  'WEBHOOK.MARKED_OPPORTUNITY',
+        'url' =>  'http://my-new-url.com',
+        'http_method' => 'POST',
+        'include_relations' => %w[CONTACT_FUNNEL]
+      }
+    end
+
+    context 'when the request is successful' do
+      let(:updated_webhook) do
+        {
+          'uuid' => uuid,
+          'event_type' => 'WEBHOOK.MARKED_OPPORTUNITY',
+          'entity_type' => 'CONTACT',
+          'url' => 'http://my-new-url.com',
+          'http_method' => 'POST',
+          'include_relations' => %w[CONTACT_FUNNEL]
+        }
+      end
+
+      before do
+        stub_request(:put, webhooks_endpoint_by_uuid)
+          .with(headers: headers, body: new_payload.to_json)
+          .to_return(status: 200, body: updated_webhook.to_json)
+      end
+
+      it 'returns the webhook' do
+        response = webhooks_client.update(uuid, new_payload)
+        expect(response).to eq(updated_webhook)
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:put, webhooks_endpoint_by_uuid)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_errors on error handler' do
+        webhooks_client.update(uuid, new_payload)
+        expect(error_handler).to have_received(:raise_errors)
+      end
+    end
+  end
+
+  describe '#delete' do
+    let(:uuid) { '5408c5a3-4711-4f2e-8d0b-13407a3e30f3' }
+    let(:webhooks_endpoint_by_uuid) { webhooks_endpoint + uuid }
+
+    context 'when the request is successful' do
+      before do
+        stub_request(:delete, webhooks_endpoint_by_uuid).with(headers: headers).to_return(status: 204)
+      end
+
+      it 'returns the webhook' do
+        response = webhooks_client.delete(uuid)
+        expect(response).to eq(message: 'Webhook deleted successfuly!')
+      end
+    end
+
+    context 'when the response contains errors' do
+      before do
+        stub_request(:delete, webhooks_endpoint_by_uuid)
+          .with(headers: headers)
+          .to_return(status: 400, body: { 'errors' => ['all errors'] }.to_json)
+      end
+
+      it 'calls raise_errors on error handler' do
+        webhooks_client.delete(uuid)
+        expect(error_handler).to have_received(:raise_errors)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -108,6 +123,7 @@ files:
 - README.md
 - Rakefile
 - lib/rdstation-ruby-client.rb
+- lib/rdstation/api_response.rb
 - lib/rdstation/authentication.rb
 - lib/rdstation/client.rb
 - lib/rdstation/contacts.rb
@@ -126,6 +142,7 @@ files:
 - lib/rdstation/events.rb
 - lib/rdstation/fields.rb
 - lib/rdstation/version.rb
+- lib/rdstation/webhooks.rb
 - rdstation-ruby-client.gemspec
 - spec/lib/rdstation-ruby-client_spec.rb
 - spec/lib/rdstation/authentication_spec.rb
@@ -144,6 +161,7 @@ files:
 - spec/lib/rdstation/error_spec.rb
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
+- spec/lib/rdstation/webhooks_spec.rb
 - spec/spec_helper.rb
 homepage: http://resultadosdigitais.com.br
 licenses:
@@ -187,4 +205,5 @@ test_files:
 - spec/lib/rdstation/error_spec.rb
 - spec/lib/rdstation/events_spec.rb
 - spec/lib/rdstation/fields_spec.rb
+- spec/lib/rdstation/webhooks_spec.rb
 - spec/spec_helper.rb