4me-sdk 1.2.0 → 2.0.0.pre.rc.1

data/spec/lib/sdk4me/response_spec.rb

@@ -13,28 +13,28 @@ describe Sdk4me::Response do
 
   def credentials(authentication)
     if authentication == :api_token
-      { basic_auth: ['secret', 'x'] }
+      { basic_auth: %w[secret x] }
     else
-      { headers: {'Authorization' => 'Bearer secret'} }
+      { headers: { 'Authorization' => 'Bearer secret' } }
     end
   end
 
-  [:api_token, :access_token].each do |authentication|
+  %i[api_token access_token].each do |authentication|
     context "#{authentication} - " do
       before(:each) do
         @person_hash = {
-          addresses:[],
-          contacts:[ {id: 1365, label: 'work', telephone: '7139872946'} ],
+          addresses: [],
+          contacts: [{ id: 1365, label: 'work', telephone: '7139872946' }],
           id: 562,
           information: 'Info about John.',
           job_title: 'rolling stone',
           locale: 'en-US',
           location: 'Top of John Hill',
           name: 'John',
-          organization: {id: 20, name: 'SDK4ME Institute'},
+          organization: { id: 20, name: 'SDK4ME Institute' },
           picture_uri: nil,
           primary_email: 'john@example.com',
-          site: {id:14, name: 'IT Training Facility'},
+          site: { id: 14, name: 'IT Training Facility' },
           time_format_24h: false,
           time_zone: 'Central Time (US & Canada)'
         }
@@ -42,9 +42,9 @@ describe Sdk4me::Response do
         @response_hash = client(authentication).get('me')
 
         @people_array = [
-          {id: 562, name: 'John', organization: { id: 20, name: 'SDK4ME Institute'}, site: {id: 14, name: 'IT Training Facility'} },
-          {id: 560, name: 'Lucas', organization: { id: 20, name: 'SDK4ME Institute', office: { name: 'The Office'}}, site: {id: 14, name: 'IT Training Facility'} },
-          {id: 561, name: 'Sheryl', organization: { id: 20, name: 'SDK4ME Institute'}, site: {id: 14, name: 'IT Training Facility'} }
+          { id: 562, name: 'John', organization: { id: 20, name: 'SDK4ME Institute' }, site: { id: 14, name: 'IT Training Facility' } },
+          { id: 560, name: 'Lucas', organization: { id: 20, name: 'SDK4ME Institute', office: { name: 'The Office' } }, site: { id: 14, name: 'IT Training Facility' } },
+          { id: 561, name: 'Sheryl', organization: { id: 20, name: 'SDK4ME Institute' }, site: { id: 14, name: 'IT Training Facility' } }
         ]
         stub_request(:get, 'https://api.4me.com/v1/people').to_return(body: @people_array.to_json).with(credentials(authentication))
         @response_array = client(authentication).get('people')
@@ -98,7 +98,7 @@ describe Sdk4me::Response do
         end
 
         it 'should add a message if the HTTP response is not OK' do
-          stub_request(:get, 'https://api.4me.com/v1/organizations').with(credentials(authentication)).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json)
+          stub_request(:get, 'https://api.4me.com/v1/organizations').with(credentials(authentication)).to_return(status: 429, body: { message: 'Too Many Requests' }.to_json)
           response = client(authentication).get('organizations')
 
           message = '429: Too Many Requests'
@@ -124,7 +124,6 @@ describe Sdk4me::Response do
         it 'should have a blank message when single record is succesfully retrieved' do
           expect(@response_array.message).to be_nil
         end
-
       end
 
       it 'should define empty' do
@@ -138,12 +137,12 @@ describe Sdk4me::Response do
 
       context 'valid' do
         it 'should be valid when the message is nil' do
-          expect(@response_hash).to receive(:message){ nil }
+          expect(@response_hash).to receive(:message) { nil }
           expect(@response_hash.valid?).to be_truthy
         end
 
         it 'should not be valid when the message is not nil' do
-          expect(@response_array).to receive(:message){ 'invalid' }
+          expect(@response_array).to receive(:message) { 'invalid' }
           expect(@response_array.valid?).to be_falsey
         end
       end
@@ -165,7 +164,7 @@ describe Sdk4me::Response do
 
         context 'list of records' do
           it 'should delegate [] to the json of each record' do
-            expect(@response_array['name']).to eq(['John', 'Lucas', 'Sheryl'])
+            expect(@response_array['name']).to eq(%w[John Lucas Sheryl])
           end
 
           it 'should allow multiple keys' do
@@ -188,7 +187,7 @@ describe Sdk4me::Response do
         end
 
         it 'should return nil if an error message is present' do
-          expect(@response_hash).to receive(:message){ 'error message' }
+          expect(@response_hash).to receive(:message) { 'error message' }
           expect(@response_hash.size).to eq(0)
         end
       end
@@ -203,7 +202,7 @@ describe Sdk4me::Response do
         end
 
         it 'should return nil if an error message is present' do
-          expect(@response_hash).to receive(:message){ 'error message' }
+          expect(@response_hash).to receive(:message) { 'error message' }
           expect(@response_hash.count).to eq(0)
         end
       end
@@ -215,9 +214,9 @@ describe Sdk4me::Response do
             'X-Pagination-Current-Page' => 1,
             'X-Pagination-Total-Pages' => 2,
             'X-Pagination-Total-Entries' => 5,
-            'Link' => '<https://api.4me.com/v1/people?page=1&per_page=3>; rel="first",<https://api.4me.com/v1/people?page=2&per_page=3>; rel="next", <https://api.4me.com/v1/people?page=2&per_page=3>; rel="last"',
+            'Link' => '<https://api.4me.com/v1/people?page=1&per_page=3>; rel="first",<https://api.4me.com/v1/people?page=2&per_page=3>; rel="next", <https://api.4me.com/v1/people?page=2&per_page=3>; rel="last"'
           }
-          allow(@response_array.response).to receive('header'){ @pagination_header }
+          allow(@response_array.response).to receive('header') { @pagination_header }
         end
 
         it "should retrieve per_page from the 'X-Pagination-Per-Page' header" do
@@ -236,19 +235,17 @@ describe Sdk4me::Response do
           expect(@response_array.total_entries).to eq(5)
         end
 
-        {first: 'https://api.4me.com/v1/people?page=1&per_page=3',
-         next: 'https://api.4me.com/v1/people?page=2&per_page=3',
-         last: 'https://api.4me.com/v1/people?page=2&per_page=3'}.each do |relation, link|
-
+        { first: 'https://api.4me.com/v1/people?page=1&per_page=3',
+          next: 'https://api.4me.com/v1/people?page=2&per_page=3',
+          last: 'https://api.4me.com/v1/people?page=2&per_page=3' }.each do |relation, link|
           it "should define pagination link for :#{relation}" do
             expect(@response_array.pagination_link(relation)).to eq(link)
           end
         end
 
-        {first: '/v1/people?page=1&per_page=3',
-         next: '/v1/people?page=2&per_page=3',
-         last: '/v1/people?page=2&per_page=3'}.each do |relation, link|
-
+        { first: '/v1/people?page=1&per_page=3',
+          next: '/v1/people?page=2&per_page=3',
+          last: '/v1/people?page=2&per_page=3' }.each do |relation, link|
           it "should define pagination relative link for :#{relation}" do
             expect(@response_array.pagination_relative_link(relation)).to eq(link)
           end
@@ -268,7 +265,7 @@ describe Sdk4me::Response do
         end
 
         it 'should check the return message' do
-          stub_request(:get, 'https://api.4me.com/v1/organizations').with(credentials(authentication)).to_return(status: 500, body: {message: 'Too Many Requests'}.to_json )
+          stub_request(:get, 'https://api.4me.com/v1/organizations').with(credentials(authentication)).to_return(status: 500, body: { message: 'Too Many Requests' }.to_json)
           response = client(authentication).get('organizations')
           expect(response.throttled?).to be_truthy
         end
@@ -285,7 +282,6 @@ describe Sdk4me::Response do
           expect(response.to_s).to eq('429: empty body')
         end
       end
-
     end
   end
 end

data/spec/lib/sdk4me_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
 describe Sdk4me do
-  it "should define a default configuration" do
+  it 'should define a default configuration' do
     conf = Sdk4me.configuration.current
 
-    expect(conf.keys.sort).to eq([:access_token, :account, :api_token, :api_version, :block_at_rate_limit, :ca_file, :host, :logger, :max_retry_time, :max_throttle_time, :proxy_host, :proxy_password, :proxy_port, :proxy_user, :read_timeout, :source])
+    expect(conf.keys.sort).to eq(%i[access_token account api_token api_version block_at_rate_limit ca_file host logger max_retry_time max_throttle_time proxy_host proxy_password proxy_port proxy_user read_timeout source])
 
     expect(conf[:logger].class).to eq(::Logger)
     expect(conf[:host]).to eq('https://api.4me.com')
@@ -16,18 +16,18 @@ describe Sdk4me do
 
     expect(conf[:proxy_port]).to eq(8080)
 
-    [:access_token, :api_token, :account, :source, :proxy_host, :proxy_user, :proxy_password].each do |no_default|
+    %i[access_token api_token account source proxy_host proxy_user proxy_password].each do |no_default|
       expect(conf[no_default]).to be_nil
     end
 
     expect(conf[:ca_file]).to eq('../ca-bundle.crt')
   end
 
-  it "should define a logger" do
+  it 'should define a logger' do
     expect(Sdk4me.logger.class).to eq(::Logger)
   end
 
-  it "should define an exception class" do
-    expect { raise ::Sdk4me::Exception.new('test') }.to raise_error('test')
+  it 'should define an exception class' do
+    expect { raise ::Sdk4me::Exception, 'test' }.to raise_error('test')
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
-# -*- encoding : utf-8 -*-
 dir = File.dirname(__FILE__)
-$LOAD_PATH.unshift dir + '/../lib'
+$LOAD_PATH.unshift "#{dir}/../lib"
 $LOAD_PATH.unshift dir
 
-STDERR.puts("Running specs using ruby version #{RUBY_VERSION}")
+warn("Running specs using ruby version #{RUBY_VERSION}")
 
 require 'simplecov'
 SimpleCov.start
@@ -26,12 +25,12 @@ require 'sdk4me/client'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir["#{dir}/support/**/*.rb"].each { |f| require f }
+Dir["#{dir}/support/**/*.rb"].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.before(:each) do
-    log_dir = File.dirname(__FILE__) + '/log'
-    Dir.mkdir(log_dir) unless File.exists?(log_dir)
+    log_dir = "#{File.dirname(__FILE__)}/log"
+    Dir.mkdir(log_dir) unless File.exist?(log_dir)
     Sdk4me.configuration.logger = Logger.new("#{log_dir}/test.log")
     @spec_dir = dir
     @fixture_dir = "#{dir}/support/fixtures"
@@ -43,6 +42,4 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
-
 end
-

data/spec/support/matchers/never_raise.rb

@@ -19,28 +19,23 @@ RSpec::Matchers.define :never_raise do |exception_class|
   end
 
   match do |block|
-    begin
-      block.call
-    rescue exception_class => e
-      global_result = "expected #{block.source_location[0]}:#{block.source_location[1]} to never raise #{exception_class.name}, but did: #{e.message}"
-      false  # we did NOT never raise this exception
-
-    rescue RSpec::Expectations::ExpectationNotMetError => exception
-      global_result = "expectation failed inside block at #{block.source_location[0]}:#{block.source_location[1]}: #{exception}"
-      # give us a pretty error message in addition to the error message from the exception
-      raise exception
-
-    rescue
-      # handle other exceptions by reraising them. They are exceptional!!!
-      # (also, no pretty error messages here)
-      raise
-
-    else
-      true   # everything ran, nothing raised at all, thus code did in fact not raise anything
-    end
+    block.call
+  rescue exception_class => e
+    global_result = "expected #{block.source_location[0]}:#{block.source_location[1]} to never raise #{exception_class.name}, but did: #{e.message}"
+    false # we did NOT never raise this exception
+  rescue RSpec::Expectations::ExpectationNotMetError => e
+    global_result = "expectation failed inside block at #{block.source_location[0]}:#{block.source_location[1]}: #{e}"
+    # give us a pretty error message in addition to the error message from the exception
+    raise e
+  rescue StandardError
+    # handle other exceptions by reraising them. They are exceptional!!!
+    # (also, no pretty error messages here)
+    raise
+  else
+    true   # everything ran, nothing raised at all, thus code did in fact not raise anything
   end
 
-  failure_message do |player|
+  failure_message do |_player|
     global_result
   end
-end
+end

data/spec/support/util.rb

@@ -1,3 +1,3 @@
 def expect_log(text, level = :info, logger = Sdk4me.configuration.logger)
-  expect(logger).to receive(level).ordered { |&args| expect(args.call).to eq(text) }
-end
+  expect(logger).to(receive(level).ordered { |&args| expect(args.call).to eq(text) })
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: 4me-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.pre.rc.1
 platform: ruby
 authors:
 - 4me
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gem_config
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: SDK for accessing the 4me API
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: SDK for accessing the 4me REST API
 email: developers@4me.com
 executables: []
 extensions: []
@@ -163,18 +177,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project:
+rubygems_version: 2.7.9
 signing_key:
 specification_version: 4
-summary: The official 4me SDK for Ruby. Provides easy access to the APIs found at
-  https://developer.4me.com
+summary: The official 4me SDK for Ruby. Provides easy access to the REST APIs found
+  at https://developer.4me.com
 test_files:
 - spec/lib/sdk4me/attachments_spec.rb
 - spec/lib/sdk4me/certificate_spec.rb