itrp-client 1.0.14 → 1.1.0

data/spec/lib/itrp/response_spec.rb

@@ -0,0 +1,271 @@
+require 'spec_helper'
+
+describe Itrp::Response do
+  before(:each) do
+    @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    @person_hash = {
+        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: 'ITRP Institute'},
+        picture_uri: nil,
+        primary_email: 'john@example.com',
+        site: {id:14, name: 'IT Training Facility'},
+        time_format_24h: false,
+        time_zone: 'Central Time (US & Canada)'
+    }
+    stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(body: @person_hash.to_json)
+    @response_hash = @client.get('me')
+
+    @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    @people_array = [
+        {id: 562, name: 'John', organization: { id: 20, name: 'ITRP Institute'}, site: {id: 14, name: 'IT Training Facility'} },
+        {id: 560, name: 'Lucas', organization: { id: 20, name: 'ITRP Institute', office: { name: 'The Office'}}, site: {id: 14, name: 'IT Training Facility'} },
+        {id: 561, name: 'Sheryl', organization: { id: 20, name: 'ITRP Institute'}, site: {id: 14, name: 'IT Training Facility'} }
+    ]
+    stub_request(:get, 'https://api.itrp.com/v1/people').to_return(body: @people_array.to_json).with(basic_auth: ['secret', 'x'])
+    @response_array = @client.get('people')
+  end
+
+  it 'should contain the request' do
+    expect(@response_hash.request.class.name).to eq('Net::HTTP::Get')
+    expect(@response_hash.request.path).to eq('/v1/me')
+  end
+
+  it 'should contain the full request' do
+    expect(@response_hash.response.class.name).to eq('Net::HTTPOK')
+    expect(@response_hash.response).to respond_to(:body)
+  end
+
+  it 'should provide easy access to the body' do
+    expect(@response_hash.body).to include(%("primary_email":"john@example.com"))
+  end
+
+  context 'json/message' do
+    it 'should provide the JSON value for single records' do
+      be_json_eql(@response_hash.json, @person_hash)
+    end
+
+    it 'should provide the JSON value for lists' do
+      be_json_eql(@response_array.json, @people_array)
+    end
+
+    it 'should provide indifferent access for single records' do
+      expect(@response_hash.json['organization']['name']).to eq('ITRP Institute')
+      expect(@response_hash.json[:organization][:name]).to eq('ITRP Institute')
+      expect(@response_hash.json[:organization]['name']).to eq('ITRP Institute')
+      expect(@response_hash.json['organization'][:name]).to eq('ITRP Institute')
+    end
+
+    it 'should provide indifferent access for lists' do
+      expect(@response_array.json.first['site']['name']).to eq('IT Training Facility')
+      expect(@response_array.json.first[:site][:name]).to eq('IT Training Facility')
+      expect(@response_array.json.last[:site]['name']).to eq('IT Training Facility')
+      expect(@response_array.json.last['site'][:name]).to eq('IT Training Facility')
+    end
+
+    it 'should add a message if the body is empty' do
+      stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: nil)
+      response = @client.get('organizations')
+
+      message = '429: empty body'
+      expect(response.json[:message]).to eq(message)
+      expect(response.json['message']).to eq(message)
+      expect(response.message).to eq(message)
+    end
+
+    it 'should add a message if the HTTP response is not OK' do
+      stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json)
+      response = @client.get('organizations')
+
+      message = '429: Too Many Requests'
+      expect(response.json[:message]).to eq(message)
+      expect(response.json['message']).to eq(message)
+      expect(response.message).to eq(message)
+    end
+
+    it 'should add a message if the JSON body cannot be parsed' do
+      stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(body: '==$$!invalid')
+      response = @client.get('organizations')
+
+      message = "Invalid JSON - 757: unexpected token at '==$$!invalid' for:\n#{response.body}"
+      expect(response.json[:message]).to eq(message)
+      expect(response.json['message']).to eq(message)
+      expect(response.message).to eq(message)
+    end
+
+    it 'should have a blank message when single record is succesfully retrieved' do
+      expect(@response_hash.message).to be_nil
+    end
+
+    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
+    stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: nil)
+    response = @client.get('organizations')
+
+    expect(response.empty?).to be_truthy
+    expect(@person_hash.empty?).to be_falsey
+    expect(@people_array.empty?).to be_falsey
+  end
+
+  context 'valid' do
+    it 'should be valid when the message is nil' do
+      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.valid?).to be_falsey
+    end
+  end
+
+  context '[] access' do
+    context 'single records' do
+      it 'should delegate [] to the json' do
+        expect(@response_hash[:name]).to eq('John')
+      end
+
+      it 'should allow multiple keys' do
+        expect(@response_hash[:organization, 'name']).to eq('ITRP Institute')
+      end
+
+      it 'should allow nils when using multiple keys' do
+        expect(@response_hash[:organization, :missing, 'name']).to be_nil
+      end
+    end
+
+    context 'list of records' do
+      it 'should delegate [] to the json of each record' do
+        expect(@response_array['name']).to eq(['John', 'Lucas', 'Sheryl'])
+      end
+
+      it 'should allow multiple keys' do
+        expect(@response_array[:organization, 'name']).to eq(['ITRP Institute', 'ITRP Institute', 'ITRP Institute'])
+      end
+
+      it 'should allow nils when using multiple keys' do
+        expect(@response_array[:organization, :office, 'name']).to eq([nil, 'The Office', nil])
+      end
+    end
+  end
+
+  context 'size' do
+    it 'should return 1 for single records' do
+      expect(@response_hash.size).to eq(1)
+    end
+
+    it 'should return the array size for list records' do
+      expect(@response_array.size).to eq(3)
+    end
+
+    it 'should return nil if an error message is present' do
+      expect(@response_hash).to receive(:message){ 'error message' }
+      expect(@response_hash.size).to eq(0)
+    end
+  end
+
+  context 'count' do
+    it 'should return 1 for single records' do
+      expect(@response_hash.count).to eq(1)
+    end
+
+    it 'should return the array size for list records' do
+      expect(@response_array.count).to eq(3)
+    end
+
+    it 'should return nil if an error message is present' do
+      expect(@response_hash).to receive(:message){ 'error message' }
+      expect(@response_hash.count).to eq(0)
+    end
+  end
+
+  context 'pagination' do
+    before(:each) do
+      @pagination_header = {
+          'X-Pagination-Per-Page' => 3,
+          'X-Pagination-Current-Page' => 1,
+          'X-Pagination-Total-Pages' => 2,
+          'X-Pagination-Total-Entries' => 5,
+          'Link' => '<https://api.itrp.com/v1/people?page=1&per_page=3>; rel="first",<https://api.itrp.com/v1/people?page=2&per_page=3>; rel="next", <https://api.itrp.com/v1/people?page=2&per_page=3>; rel="last"',
+      }
+      allow(@response_array.response).to receive('header'){ @pagination_header }
+    end
+
+    it "should retrieve per_page from the 'X-Pagination-Per-Page' header" do
+      expect(@response_array.per_page).to eq(3)
+    end
+
+    it "should retrieve current_page from the 'X-Pagination-Current-Page' header" do
+      expect(@response_array.current_page).to eq(1)
+    end
+
+    it "should retrieve total_pages from the 'X-Pagination-Total-Pages' header" do
+      expect(@response_array.total_pages).to eq(2)
+    end
+
+    it "should retrieve total_entries from the 'X-Pagination-Total-Entries' header" do
+      expect(@response_array.total_entries).to eq(5)
+    end
+
+    {first: 'https://api.itrp.com/v1/people?page=1&per_page=3',
+     next: 'https://api.itrp.com/v1/people?page=2&per_page=3',
+     last: 'https://api.itrp.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|
+
+      it "should define pagination relative link for :#{relation}" do
+        expect(@response_array.pagination_relative_link(relation)).to eq(link)
+      end
+    end
+  end
+
+  context 'throttled?' do
+    it 'should not be trhottled by default' do
+      expect(@response_hash.throttled?).to be_falsey
+      expect(@response_array.throttled?).to be_falsey
+    end
+
+    it 'should check the return code' do
+      stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: nil)
+      response = @client.get('organizations')
+      expect(response.throttled?).to be_truthy
+    end
+
+    it 'should check the return message' do
+      stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(status: 500, body: {message: 'Too Many Requests'}.to_json )
+      response = @client.get('organizations')
+      expect(response.throttled?).to be_truthy
+    end
+  end
+
+  context 'to_s' do
+    it 'should return the JSON as a string' do
+      expect(@response_hash.to_s).to eq(JSON.parse(@person_hash.to_json).to_s)
+    end
+
+    it 'should return the message in case the response is not valid' do
+      stub_request(:get, 'https://api.itrp.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: nil)
+      response = @client.get('organizations')
+      expect(response.to_s).to eq('429: empty body')
+    end
+  end
+
+end

data/spec/lib/itrp_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Itrp do
+  it "should define a default configuration" do
+    conf = Itrp.configuration.current
+
+    expect(conf.keys.sort).to eq([:account, :api_token, :api_version, :block_at_rate_limit, :ca_file, :host, :logger, :max_retry_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.itrp.com')
+    expect(conf[:api_version]).to eq('v1')
+
+    expect(conf[:max_retry_time]).to eq(5400)
+    expect(conf[:read_timeout]).to eq(25)
+    expect(conf[:block_at_rate_limit]).to be_falsey
+
+    expect(conf[:proxy_port]).to eq(8080)
+
+    [: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
+    expect(Itrp.logger.class).to eq(::Logger)
+  end
+
+  it "should define an exception class" do
+    expect { raise ::Itrp::Exception.new('test') }.to raise_error('test')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir + '/../lib'
+$LOAD_PATH.unshift dir
+
+STDERR.puts("Running specs using ruby version #{RUBY_VERSION}")
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'webmock/rspec'
+
+# Patch for https://github.com/bblimke/webmock/issues/623
+module WebMock
+  class BodyPattern
+    def assert_non_multipart_body(content_type)
+      # if content_type =~ %r{^multipart/form-data}
+      #   raise ArgumentError.new("WebMock does not support matching body for multipart/form-data requests yet :(")
+      # end
+    end
+  end
+end
+
+require 'itrp/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 }
+
+RSpec.configure do |config|
+  config.before(:each) do
+    log_dir = File.dirname(__FILE__) + '/log'
+    Dir.mkdir(log_dir) unless File.exists?(log_dir)
+    Itrp.configuration.logger = Logger.new("#{log_dir}/test.log")
+    @spec_dir = dir
+    @fixture_dir = "#{dir}/support/fixtures"
+  end
+  config.after(:each) { Itrp.configuration.reset }
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+end
+

data/spec/support/fixtures/people.csv

@@ -0,0 +1,3 @@
+Primary Email,Name
+chess.cole@example.com,Chess Cole
+ed.turner@example.com,Ed Turner

data/spec/support/fixtures/upload.txt

@@ -0,0 +1 @@
+content

data/spec/support/matchers/never_raise.rb

@@ -0,0 +1,46 @@
+# This matcher will return:
+#    1. TRUE if the code was run without exceptions
+#    2. FALSE if the code was run but raised (only) the specified exception
+#
+# It *will* raise an exception if the block of code raises an exception other than
+# (the exception specified)
+#
+# To use it
+#
+# expect {
+#  code
+# }.to never_raise(MySpecificException)
+#
+RSpec::Matchers.define :never_raise do |exception_class|
+  global_result = nil
+
+  def supports_block_expectations?
+    true # or some logic
+  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
+  end
+
+  failure_message do |player|
+    global_result
+  end
+end

data/spec/support/util.rb

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

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: itrp-client
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.1.0
 platform: ruby
 authors:
 - ITRP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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'
 description: Client for accessing the ITRP REST API
@@ -140,30 +140,49 @@ files:
 - lib/itrp/client/multipart.rb
 - lib/itrp/client/response.rb
 - lib/itrp/client/version.rb
+- spec/lib/itrp/attachments_spec.rb
+- spec/lib/itrp/certificate_spec.rb
+- spec/lib/itrp/client_spec.rb
+- spec/lib/itrp/response_spec.rb
+- spec/lib/itrp_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/people.csv
+- spec/support/fixtures/upload.txt
+- spec/support/matchers/never_raise.rb
+- spec/support/util.rb
 homepage: http://github.com/itrp/itrp-client
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--charset=UTF-8"
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Client for accessing the ITRP REST API
-test_files: []
-has_rdoc: 
+test_files:
+- spec/lib/itrp/attachments_spec.rb
+- spec/lib/itrp/certificate_spec.rb
+- spec/lib/itrp/client_spec.rb
+- spec/lib/itrp/response_spec.rb
+- spec/lib/itrp_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/people.csv
+- spec/support/fixtures/upload.txt
+- spec/support/matchers/never_raise.rb
+- spec/support/util.rb