rtx-api 0.4.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b63f758c0c2bca1e1d6746d9b046c7a8d39bdc
-  data.tar.gz: 57790164cc08bfdd07d12e8a60a01eb0b2daf605
+  metadata.gz: aa3fab23dbc7d2054379829a2fa8c0c5889533dc
+  data.tar.gz: fc712c4b1bfbf5efcdff43cca9d217c5f3e7abba
 SHA512:
-  metadata.gz: 8bdbccc1be110d39ac17238786d4c6612a2d21a678a3122677cf206caa329e2783029cc4b50d95ded4fe06555bb01951b68ba713824981eea2c6a5fe2f7a71ac
-  data.tar.gz: 83cb2bf41ed17f9d8afa9c072be126d4b23221c0b689081e058a3b9d0e435cdaebab82d47f795bd27e85542d574dbad8f994c1179ac75910730770d9f5231f05
+  metadata.gz: 71780b2bf492eb41fcffb6296c26798b775c4f9ce746d1600da1c9cb59ad6e284cc45b1329b531b5b5c8783edc985148606102491047e120127a717a5b4e0e6d
+  data.tar.gz: 98bff0d00cd40422ae374edf0a52c419ea6363151a9eace87e5d1a12283ac74292dd6d1a1ef35bbff08312b60280135cfc86791ba7a26c48551118c9ad39640d

data/.rubocop.yml

@@ -0,0 +1,58 @@
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/Documentation:
+  Enabled: false
+
+Naming/VariableName:
+  EnforcedStyle: snake_case
+
+Naming/PredicateName:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/ModuleLength:
+  Max: 100
+  Exclude:
+    - spec/data/**
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/LineLength:
+  Max: 100
+  IgnoredPatterns: ['\A#']
+  Exclude:
+    - spec/**/**_spec.rb
+    - spec/data/**
+    - bin/**/*
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5.0
+  Exclude:
+    - .git/**/*
+    - vendor/**/*
+    - Gemfile
+    - Rakefile
+    - rtx-api.gemspec

data/.travis.yml

@@ -5,11 +5,11 @@ addons:
 gemfile:
 - Gemfile
 rvm:
-- 2.1
-- 2.2
 - 2.3.0
+- 2.5.0
+- 2.6.0
 script:
-- bundle exec rake test
+- bundle exec rubocop && bundle exec rake test
 env:
   global:
     - COVERAGE=1

data/Gemfile

@@ -2,13 +2,14 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'pry'
   gem 'httparty'
   gem 'oj'
+  gem 'pry'
 end
 
 group :development, :test, :rake do
   gem 'bundler'
+  gem 'rubocop', require: false
 end
 
 group :rake do
@@ -17,8 +18,8 @@ end
 
 group :test do
   gem 'minitest'
-  gem 'minitest-spec-context'
   gem 'minitest-reporters', require: 'minitest/reporters'
+  gem 'minitest-spec-context'
   gem 'mocha', require: 'mocha/setup'
   gem 'vcr', require: false
   gem 'webmock', require: false

data/README.md

@@ -18,6 +18,20 @@ By adding `RTX_USER_EMAIL` and `RTX_USER_PASSWORD` to your environment variables
 
 If you using a different url for for the RTX API, you can set the `RTX_API_URL` environment variable to use the appropriate one.
 
+## Testing locally
+
+In order to test changes to your gem without having to release, you can update the Gemfile to point to the local version of the Gem
+
+    gem 'rtx-api', require: 'rtx/api', path: '../rtx-api-client-ruby'
+
+## Releasing new version
+
+We have a higher expectation of testing in this repo than others due to the lower volume of releases and nature of the product.  When you are submitting your PR, take a more conservative approach to testing and make sure you are adding tests for all new/changed methods.
+
+Bump the version of the gem within `./lib/rtx/api/version.rb` based on the changes you've made. Once your changes have been merged into master, you can release updated version of your gem. In order to release, you will need to be an owner of the RubyGems project and need to have your API credentials setup in your bash profile. Once complete, run the following command release command. 
+
+    bundle exec rake release
+
 ## Usage
 
 The client is lazily loaded, which means it will not authenticate until you make your initial request. Once the request is performed, we'll store the information for future requests. You will want to use the same instance of the client to perform all of your requests.

data/bin/console

@@ -1,8 +1,10 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# !/usr/bin/env ruby
 ENV['RACK_ENV'] ||= 'development'
 # load path
-lib_path = File.expand_path('../../lib', __FILE__)
-($:.unshift lib_path) unless ($:.include? lib_path)
+lib_path = File.expand_path('../lib', __dir__)
+($LOAD_PATH.unshift lib_path) unless $LOAD_PATH.include? lib_path
 
 # require farm
 require 'bundler'

data/lib/rtx/api/client.rb

@@ -1,12 +1,18 @@
+# frozen_string_literal: true
+
+require 'csv'
+
 module RTX
   module API
     class Client
       include HTTParty
-      attr_accessor :email, :password, :token, :expires, :account_id, :profile_id
+      attr_accessor :email, :password, :api_url, :token, :expires, :account_id, :profile_id
 
-      def initialize(email = ENV["RTX_USER_EMAIL"], password = ENV["RTX_USER_PASSWORD"])
+      def initialize(email = ENV['RTX_USER_EMAIL'], password = ENV['RTX_USER_PASSWORD'],
+                     api_url = ENV['RTX_API_URL'])
         @email = email
         @password = password
+        @api_url = api_url
         @token = nil
         @expires = nil
       end
@@ -16,26 +22,36 @@ module RTX
       end
 
       def authenticate
-        request = self.class.post("#{rtx_api_url}/auth", headers: default_headers, basic_auth: {username: email, password: password})
+        request = self.class.post("#{rtx_api_url}/auth", headers: default_headers,
+                                                         basic_auth: {
+                                                           username: email,
+                                                           password: password
+                                                         })
         response = Oj.load(request.body, symbol_keys: true)
         if request.code != 201
-          raise API::Errors::AuthenticationError.new("Authentication Login Error: #{response}")
+          raise API::Errors::AuthenticationError, "Authentication Login Error: #{response}"
         end
-        set_attributes(response[:token], response[:expires_at], response[:account_id], response[:profile_id])
+
+        set_attributes(response[:token], response[:expires_at], response[:account_id],
+                       response[:profile_id])
       end
 
       def authenticate_as(email, &block)
         authenticate if !authenticated?
         response = collection(:users, email: email)
-        if response[:_total] == 1
-          user = response[:_embedded][:users][0]
-          auth_response = post(:auth_tokens, account_id: user[:account_id], user_id: user[:id])
-          client = self.class.new(auth_response[:email], auth_response[:token])
-          client.set_attributes(auth_response[:token], auth_response[:expires_at], auth_response[:account_id], auth_response[:profile_id])
-          block.call(client)
-        else
-          raise API::Errors::ClientError.new("User not found with associated email address: #{email}")
+
+        unless response[:_total] == 1
+          raise API::Errors::ClientError,
+                "User not found with associated email address: #{email}"
         end
+
+        user = response[:_embedded][:users][0]
+        auth_response = post(:auth_tokens, account_id: user[:account_id], user_id: user[:id])
+        client = self.class.new(auth_response[:email], auth_response[:token])
+        client.set_attributes(auth_response[:token], auth_response[:expires_at],
+                              auth_response[:account_id], auth_response[:profile_id])
+        block.call(client)
+
         true
       end
 
@@ -44,76 +60,111 @@ module RTX
       end
 
       def logout
-        if token
-          request = self.class.delete("#{rtx_api_url}/auth", options(:delete))
-          if request.code != 204
-            raise API::Errors::AuthenticationError.new("Authentication Logout Error: #{request}")
-          end
-          @token, @expires, @account_id, @profile_id = nil, nil, nil, nil
+        return unless token
+
+        request = self.class.delete("#{rtx_api_url}/auth", options(:delete))
+        if request.code != 204
+          raise API::Errors::AuthenticationError, "Authentication Logout Error: #{request}"
         end
+
+        @token = nil
+        @expires = nil
+        @account_id = nil
+        @profile_id = nil
       end
 
-      def method_missing(method, *args, &block)
-        if resource_path(method)
-          attrs = {}
-          if args.size > 0
-            attrs = args.last.is_a?(Hash) ? args.pop : {}
-          end
-          RTX::API::Collection.new(self, method, attrs)
+      # rubocop:disable Lint/RedundantCopDisableDirective
+      # rubocop:disable Style/MissingRespondToMissing
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method, *args)
+        return unless resource_path(method)
+
+        attrs = {}
+        if args.size.positive?
+          attrs = args.last.is_a?(Hash) ? args.pop : {}
         end
+
+        # Use V2 Collection if prefixed with V2
+        return RTX::API::CollectionV2.new(self, method, attrs) if method.to_s.start_with?('v2_')
+
+        RTX::API::Collection.new(self, method, attrs)
       end
+      # rubocop:enable Style/MissingRespondToMissing
+      # rubocop:enable Style/MethodMissingSuper
+      # rubocop:enable Lint/RedundantCopDisableDirective
 
       def collection(resource_name, attrs = {})
-        request = self.class.get("#{rtx_api_url}/#{resource_path(resource_name)}", options(:get, attrs))
+        request = self.class.get("#{rtx_api_url}/#{resource_path(resource_name)}",
+                                 options(:get, attrs))
         handle_request(request)
       end
 
       def detail(resource_name, resource_id, attrs = {})
-        raise API::Errors::RequestError.new("id was not provided") if resource_id.nil?
-        request = self.class.get("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}", options(:get, attrs))
+        raise API::Errors::RequestError, 'id was not provided' if resource_id.nil?
+
+        request = self.class.get("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}",
+                                 options(:get, attrs))
         handle_request(request)
       end
 
       def post(resource_name, attrs = {})
-        request = self.class.post("#{rtx_api_url}/#{resource_path(resource_name)}", options(:post, attrs))
+        request = self.class.post("#{rtx_api_url}/#{resource_path(resource_name)}",
+                                  options(:post, attrs))
         handle_request(request)
       end
 
       def put(resource_name, resource_id, attrs = {})
-        raise API::Errors::RequestError.new("id was not provided") if resource_id.nil?
-        request = self.class.put("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}", options(:put, attrs))
+        raise API::Errors::RequestError, 'id was not provided' if resource_id.nil?
+
+        request = self.class.put("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}",
+                                 options(:put, attrs))
         handle_request(request)
       end
 
       def patch(resource_name, resource_id, attrs = {})
-        raise API::Errors::RequestError.new("id was not provided") if resource_id.nil?
-        request = self.class.patch("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}", options(:patch, attrs))
+        raise API::Errors::RequestError, 'id was not provided' if resource_id.nil?
+
+        request = self.class.patch("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}",
+                                   options(:patch, attrs))
         handle_request(request)
       end
 
       def delete(resource_name, resource_id)
-        raise API::Errors::RequestError.new("id was not provided") if resource_id.nil?
-        request = self.class.delete("#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}", options(:delete))
+        raise API::Errors::RequestError, 'id was not provided' if resource_id.nil?
+
+        request = self.class.delete(
+          "#{rtx_api_url}/#{resource_path(resource_name)}/#{resource_id}", options(:delete)
+        )
         handle_request(request)
       end
 
-      def handle_request(request)
-        if !request.success?
-          raise API::Errors::RequestError.new("#{request.parsed_response}")
-        end
+      def get(resource_name, attrs = {}, file_type = 'json')
+        request = self.class.get("#{rtx_api_url}/#{resource_path(resource_name)}",
+                                 options(:get, attrs))
 
-        if request.parsed_response.nil?
-          return true
-        end
+        handle_request(request, file_type)
+      end
+
+      def handle_request(request, file_type = 'json')
+        raise API::Errors::RequestError, request.parsed_response.to_s if !request.success?
 
-        Oj.load(request.body, symbol_keys: true)
+        return true if request.parsed_response.nil?
+
+        case file_type
+        when 'json'
+          Oj.load(request.body, symbol_keys: true)
+        when 'csv'
+          CSV.parse(request.body)
+        end
       end
 
       def resource_path(resource_name)
         path = API::Resources.allowed_resources[resource_name.to_sym]
         if !path
-          raise API::Errors::InvalidResourceError.new("The resource provided (#{resource_name}) is not allowed")
+          raise API::Errors::InvalidResourceError,
+                "The resource provided (#{resource_name}) is not allowed"
         end
+
         path
       end
 
@@ -128,14 +179,14 @@ module RTX
 
       def default_headers
         {
-          'Content-Type' => "application/hal+json",
-          'Accept' => "application/hal+json",
+          'Content-Type' => 'application/hal+json',
+          'Accept' => 'application/hal+json',
           'User-Agent' => "rtx-api-client-ruby/#{API::VERSION}"
         }.freeze
       end
 
       def options(action, attrs = {})
-        options = {headers: default_headers, basic_auth: {username: email, password: token}}
+        options = { headers: default_headers, basic_auth: { username: email, password: token } }
         if write_request?(action)
           options[:body] = Oj.dump(attrs, mode: :compat)
         else
@@ -145,11 +196,11 @@ module RTX
       end
 
       def rtx_api_url
-        ENV["RTX_API_URL"] || "https://api-gateway.reviewtrackers.com"
+        api_url || ENV['RTX_API_URL'] || 'https://api-gateway.reviewtrackers.com'
       end
 
       def write_request?(action)
-        (action == :post || action == :put || action == :patch)
+        %i[post put patch].include?(action)
       end
     end
   end

data/lib/rtx/api/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RTX
   module API
     class Collection
@@ -40,7 +42,13 @@ module RTX
         delete(symbolize_hash(attrs))
       end
 
-      # Chainable method that allows you to set the per page number of the collection for your request
+      def get!(attrs = {}, file_type = 'json')
+        client.authenticate if !client.authenticated?
+        get(symbolize_hash(attrs), file_type)
+      end
+
+      # Chainable method that allows you to set the per page number of
+      # the collection for your request
       def per_page(num)
         clear if !num.nil?
         @options[:per_page] = num
@@ -65,22 +73,18 @@ module RTX
       def meta
         client.authenticate if !client.authenticated?
         collection if !has_response?
-        response.reject {|key,_| key == :_embedded}
+        response.reject { |key, _| key == :_embedded }
       end
 
       # For moving forward one page with the collection
       def next
-        if has_next?
-          page(options[:page] += 1)
-        end
+        page(options[:page] += 1) if has_next?
         self
       end
 
       # For moving backward one page with the collection
       def prev
-        if has_previous?
-          page(options[:page] -= 1)
-        end
+        page(options[:page] -= 1) if has_previous?
         self
       end
 
@@ -116,7 +120,8 @@ module RTX
         end
       end
 
-      # Allows you to loop through all of the resources within the pages specified and retrieve the records
+      # Allows you to loop through all of the resources
+      # within the pages specified and retrieve the records
       def all_resources(initial_page = 1, &block)
         all_pages(initial_page) do |page|
           page.each do |resource|
@@ -164,12 +169,16 @@ module RTX
         client.delete(resource_name, resource_id)
       end
 
+      def get(attrs = {}, file_type = 'json')
+        client.get(resource_name, attrs, file_type)
+      end
+
       def has_response?
         response != {}
       end
 
       def symbolize_hash(hash)
-        Hash[hash.map{|(key,value)| [key.to_sym,value]}]
+        Hash[hash.map { |(key, value)| [key.to_sym, value] }]
       end
     end
   end

data/lib/rtx/api/collection_v2.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module RTX
+  module API
+    class CollectionV2
+      attr_accessor :client, :resource_name, :response, :options
+
+      def initialize(client, resource_name, attrs = {})
+        @client = client
+        @resource_name = resource_name.to_sym
+        @options = symbolize_hash(attrs)
+        @response = {}
+      end
+
+      # Chainable method that allows you to set
+      # the per page number of the collection for your request
+      def per_page(num)
+        clear if !num.nil?
+        @options[:per_page] = num
+        self
+      end
+
+      # Returns all data associated with the existing response
+      def data
+        client.authenticate if !client.authenticated?
+        collection if !has_response?
+        response[:data]
+      end
+
+      # Returns the paging information about the current response
+      def paging
+        client.authenticate if !client.authenticated?
+        collection if !has_response?
+        response[:paging]
+      end
+
+      # For moving forward one page with the collection
+      def next
+        next_page(after_token) if has_next?
+        self
+      end
+
+      # For moving backward one page with the collection
+      def prev
+        previous_page(before_token) if has_previous?
+        self
+      end
+
+      # Responds true if the collection has another page ahead of it
+      def has_next?
+        !after_token.nil?
+      end
+
+      # Responds true if the collection has a previous one
+      def has_previous?
+        !before_token.nil?
+      end
+
+      # Allows you to loop through all of the pages and retrieve the records
+      def all_pages(&block)
+        loop do
+          # Return first page
+          block.call(data)
+
+          # No need to continue if all data is retrieved
+          break unless has_next?
+
+          # Navigate to the next page
+          self.next
+        end
+      end
+
+      # Allows you to loop through all of
+      # the resources within the pages specified and retrieve the records
+      def all_resources(&block)
+        all_pages do |page|
+          page.each do |resource|
+            block.call(resource)
+          end
+        end
+      end
+
+      protected
+
+      # Chainable method that allows you to get the next page for a given after token
+      def next_page(after_token)
+        clear
+        @options[:after] = after_token
+        self
+      end
+
+      # Chainable method that allows you to get the previous page for a given before token
+      def previous_page(before_token)
+        clear
+        @options[:before] = before_token
+        self
+      end
+
+      def after_token
+        return nil if paging.nil?
+        return nil if paging[:cursors].nil?
+
+        paging[:cursors][:after]
+      end
+
+      def before_token
+        return nil if paging.nil?
+        return nil if paging[:cursors].nil?
+
+        paging[:cursors][:before]
+      end
+
+      def clear
+        @response = {}
+      end
+
+      def collection
+        @response = client.collection(resource_name, options)
+      end
+
+      def has_response?
+        response != {}
+      end
+
+      def symbolize_hash(hash)
+        Hash[hash.map { |(key, value)| [key.to_sym, value] }]
+      end
+    end
+  end
+end

data/lib/rtx/api/errors/authentication_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RTX
   module API
     module Errors

data/lib/rtx/api/errors/client_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RTX
   module API
     module Errors

data/lib/rtx/api/errors/invalid_resource_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RTX
   module API
     module Errors

data/lib/rtx/api/errors/request_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RTX
   module API
     module Errors

data/lib/rtx/api/resources.rb

@@ -21,6 +21,8 @@ module RTX
           items: 'items',
           layouts: 'layouts',
           locations: 'locations',
+          metric_locations: 'export/csv/location_metrics',
+          metric_groups: 'export/csv/group_metrics',
           notes: 'notes',
           passwords: 'passwords',
           permissions: 'permissions',
@@ -40,7 +42,9 @@ module RTX
           urls: 'urls',
           users: 'users',
           user_types: 'user_types',
-          whitelabels: 'whitelabels'
+          whitelabels: 'whitelabels',
+          v2_reviews: 'v2/reviews',
+          v2_reviews_csv: 'v2/reviews_csv'
         }.freeze
       end
       # rubocop:enable Metrics/MethodLength

data/lib/rtx/api/version.rb

@@ -2,6 +2,6 @@
 
 module RTX
   module API
-    VERSION = '0.4.3'
+    VERSION = '0.6.1'
   end
 end

data/lib/rtx/api.rb

@@ -1,20 +1,23 @@
-require "oj"
-require "httparty"
-require "rtx/api/version"
+# frozen_string_literal: true
+
+require 'oj'
+require 'httparty'
+require 'rtx/api/version'
 
 # client
-require "rtx/api/client"
+require 'rtx/api/client'
 
 # resources
-require "rtx/api/resources"
-require "rtx/api/collection"
+require 'rtx/api/resources'
+require 'rtx/api/collection'
+require 'rtx/api/collection_v2'
 
 # errors
-require "rtx/api/errors/client_error"
-require "rtx/api/errors/authentication_error"
-require "rtx/api/errors/request_error"
-require "rtx/api/errors/invalid_resource_error"
+require 'rtx/api/errors/client_error'
+require 'rtx/api/errors/authentication_error'
+require 'rtx/api/errors/request_error'
+require 'rtx/api/errors/invalid_resource_error'
 
 module RTX
   module API; end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtx-api
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Review Trackers Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -83,6 +84,7 @@ files:
 - lib/rtx/api.rb
 - lib/rtx/api/client.rb
 - lib/rtx/api/collection.rb
+- lib/rtx/api/collection_v2.rb
 - lib/rtx/api/errors/authentication_error.rb
 - lib/rtx/api/errors/client_error.rb
 - lib/rtx/api/errors/invalid_resource_error.rb
@@ -91,11 +93,11 @@ files:
 - lib/rtx/api/version.rb
 - pull_request_template.md
 - rtx-api.gemspec
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,9 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.6.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby Client for the Review Trackers RTX API.
 test_files: []