rtx-api 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1cb8509c76c825a79bc394284067d1828e9255f5
-  data.tar.gz: 6a2162d1c63900e40ad4f3d6358e370eb8333434
+SHA256:
+  metadata.gz: 9501dcc7112fefb26fa0cfea1259aa23e1b8cc45b64971e39f426cf11913bc13
+  data.tar.gz: d4b91f77fb51cca1d8dd067e8ab87372921c72c380d3bf210091132e8adf44da
 SHA512:
-  metadata.gz: 0b63e7b806a601be000451c64ceedad226c18a6a58a25b4b262ccb012b65d9aa151b6574fd9850ccb6a4a3216c74b7b1f537088534038c30f723147ce1685eea
-  data.tar.gz: 1b4744b8ac44f42061911d9ae7dbb64a81c906f39bc0c59625902d437479fb432bfc7bb1481a827f164d2d12edfb33938c909c295db2692511adf1a7bf9f0f46
+  metadata.gz: fd462a434c9feced48e18a238d5edef6a1e84b64c4763e1f8fe0b6ed8c4a10bcb17bf95b7b834264aa4082aebb785cfd4324e125f7df5b209f9e56852dbc8e00
+  data.tar.gz: ec4008817753110b2d22d8fd4eee9262182cc2c0d97ae673bb22d37c6368a6dde3dc7c8db738b3518ea6a0422c6f77763647053dfce35df0b0b2fc6ac81bd173

data/README.md

@@ -18,6 +18,18 @@ 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
+
+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/lib/rtx/api.rb

@@ -8,6 +8,7 @@ require "rtx/api/client"
 # resources
 require "rtx/api/resources"
 require "rtx/api/collection"
+require "rtx/api/collection_v2"
 
 # errors
 require "rtx/api/errors/client_error"

data/lib/rtx/api/client.rb

@@ -2,11 +2,12 @@ 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
@@ -59,6 +60,10 @@ module RTX
           if args.size > 0
             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
       end
@@ -145,7 +150,7 @@ 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)

data/lib/rtx/api/collection_v2.rb

@@ -0,0 +1,130 @@
+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
+        if has_next?
+          next_page(after_token)
+        end
+        self
+      end
+
+      # For moving backward one page with the collection
+      def prev
+        if has_previous?
+          previous_page(before_token)
+        end
+        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/resources.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module RTX
   module API
     class Resources
+      # rubocop:disable Metrics/MethodLength
       def self.allowed_resources
         {
           accounts: 'accounts',
+          account_settings: 'account_settings',
           alerts: 'alerts',
           alert_frequencies: 'alert_frequencies',
           alert_types: 'alert_types',
@@ -18,7 +22,9 @@ module RTX
           layouts: 'layouts',
           locations: 'locations',
           notes: 'notes',
+          passwords: 'passwords',
           permissions: 'permissions',
+          plan_changes: 'plan_changes',
           profiles: 'profiles',
           requests: 'requests',
           request_pages: 'request_pages',
@@ -34,9 +40,12 @@ 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
     end
   end
 end

data/lib/rtx/api/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RTX
   module API
-    VERSION = "0.4.1"
+    VERSION = '0.5.1'
   end
 end

data/pull_request_template.md

@@ -0,0 +1,18 @@
+# Title
+[Link to passing hydra (unless you're triggering through this PR)]
+
+[Description]
+
+#### Do you have tests for your changes? 
+- [ ] Yes
+- [ ] No (if no, why not?)
+
+# Proof
+
+## Before
+[Attach prior behavior if applicable]
+
+## After
+[Attach new behavior proof]
+
+- [ ] Zach's Checkbox (aka: I've manually regression tested any large changes)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtx-api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Review Trackers Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -83,18 +83,20 @@ 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
 - lib/rtx/api/errors/request_error.rb
 - lib/rtx/api/resources.rb
 - 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
@@ -109,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.1
+signing_key:
 specification_version: 4
 summary: Ruby Client for the Review Trackers RTX API.
 test_files: []