nolij_web 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc3762bd0096669b24ea98624301805113fa207c
+  data.tar.gz: 3760f6b1bd03602102a98ee237c1afeeeab4a1f3
+SHA512:
+  metadata.gz: c749b2069299e2af3eaffd48e7616a3681f558ea502e99882381b766f77c0a405b4be5e6a235b28772310fc71961bed2145a8b4833b829093c34a81229595c96
+  data.tar.gz: 3bfccb342790994659c1feea4769bac4715e2bd17e0ba7cbe0bed611cc592094f811ae7cd736d44b11b2324fad40cb55ceb09ee2a718e6c1f3ce05b5b9e47a5b

data/README.rdoc

@@ -33,7 +33,8 @@ Configuration can be passed as an assigned hash
   config = {
             :username => 'username',
             :password => 'password',
-            :base_url => 'https://somedomain.com/NolijWeb'
+            :base_url => 'https://somedomain.com/NolijWeb',
+            :verify_ssl => true # optional, defaults to true
            }
 
 Configuration can be read from a YAML file by passing the file path. The file should contain a hash structure:
@@ -41,6 +42,7 @@ Configuration can be read from a YAML file by passing the file path. The file sh
   :username: 'username'
   :password: 'password'
   :base_url: 'https://somedomain.com/NolijWeb'
+  :verify_ssl: true # optional, defaults to true
 
 == Passing a block to NolijWeb::Handler methods
 You may pass a custom block to handler methods. Please note that your block should return the response for successful request. Some of the methods rely on parsing XML responses from the server.

data/lib/nolij_web/connection.rb

@@ -16,7 +16,7 @@ Nolijweb::Connection is the class that handles actual Nolijweb api sessions and
 ===Manual Usage
 You can manually establish a connection and use the _custom_connection methods to execute multiple requests in series.
 
-Be sure the close the connection when you are finished.
+Be sure to close the connection when you are finished.
 
   conn = NolijWeb::Connection.new(config_hash_or_yaml_path)
   conn.establish_connection
@@ -30,7 +30,7 @@ Be sure the close the connection when you are finished.
     attr_reader :connection
     attr_reader :headers
 
-    @@valid_config_keys = [:username, :password, :base_url]
+    @@valid_config_keys = [:username, :password, :base_url, :verify_ssl]
 
     def initialize(config)
       if config.is_a?(String)
@@ -51,6 +51,7 @@ Be sure the close the connection when you are finished.
       @base_url = @config[:base_url] || ''
       @username = @config[:username] || ''
       @password = @config[:password] || ''
+      @verify_ssl = (@config[:verify_ssl].nil? || @config[:verify_ssl] === true) ? true : !((@config[:verify_ssl] === false) || (@config[:verify_ssl] =~ /^(false|f|no|n|0)$/i))
       @connection = nil
       @cookies = nil
       @headers = {}
@@ -73,7 +74,7 @@ Be sure the close the connection when you are finished.
     end
 
     def establish_connection
-      @connection = RestClient.post("#{@base_url}/j_spring_security_check", {:j_username => @username, :j_password => @password}) { |response, request, result, &block|
+      @connection = post_custom_connection("#{@base_url}/j_spring_security_check", {:j_username => @username, :j_password => @password}) { |response, request, result, &block|
         if [301, 302, 307].include? response.code
           response
         else
@@ -86,7 +87,7 @@ Be sure the close the connection when you are finished.
     end
 
     def close_connection
-      RestClient.get("#{@base_url}/j_spring_security_logout", :cookies => @cookies) if @connection
+      rest_client_wrapper(:get, "#{@base_url}/j_spring_security_logout", :cookies => @cookies) if @connection
       @connection = nil
       @cookies = nil
       @headers = {}
@@ -125,21 +126,28 @@ Be sure the close the connection when you are finished.
     def get_custom_connection(path, headers = {}, &block)
       block ||= default_response_handler
       url = URI.join(@base_url, URI.parse(@base_url).path + '/', path.to_s).to_s
-      RestClient.get(url, headers, &block)
+      rest_client_wrapper(:get, url, headers, &block)
     end
 
     # Use this inside an execute block to make mulitiple calls in the same request
     def delete_custom_connection(path, headers = {}, &block)
       block ||= default_response_handler
       url = URI.join(@base_url, URI.parse(@base_url).path + '/', path.to_s).to_s
-      RestClient.delete(url, headers, &block)
+      rest_client_wrapper(:delete, url, headers, &block)
     end
 
     # Use this inside an execute block to make mulitiple calls in the same request
     def post_custom_connection(path, payload, headers = {}, &block)
       block ||= default_response_handler
       url = URI.join(@base_url, URI.parse(@base_url).path + '/', path.to_s).to_s
-      RestClient.post(url, payload, headers, &block)
+      RestClient::Request.execute(method: :post, url: url, payload: payload, headers: headers, verify_ssl: @verify_ssl, &block)
+    end
+
+    # RestClient.get/put/delete offer no way to pass additional arguments, so 
+    # a wrapper is recommended: 
+    # https://github.com/rest-client/rest-client/issues/297
+    def rest_client_wrapper(method, url, headers={}, &block)
+      RestClient::Request.execute(method: method, url: url, headers: headers, verify_ssl: @verify_ssl, &block)
     end
 
 private

data/lib/nolij_web/handler.rb

@@ -47,7 +47,7 @@ module NolijWeb
     # Submit a file.
     # A local file path is required.
     # required options: :folder_id
-    # additional options: :user_code, :wfma_code, :index_code, :dept_code, :custom_name, :folder_name
+    # additional options: :user_code, :wfma_code, :index_code, :dept_code, :custom_name
     def submit_document(local_file, options = {}, &block)
       folder_id = options[:folder_id]
       folder_id = if folder_id.kind_of?(Numeric) || folder_id.kind_of?(String)

data/lib/nolij_web/version.rb

@@ -1,5 +1,5 @@
 module NolijWeb
   class Version
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/test/nolij_web/connection_test.rb

@@ -16,12 +16,12 @@ describe NolijWeb::Connection do
 
   #stubs connection and requests for full authenticated round trip
   def stub_connection_round_trip(connection)
-    @cookies = {'k' => 'v', 'a' => 'b'}
+    @cookies = {'a' => 'b'}
 
     @stubbed_login = stub_request(:post, "#{@base_url}/j_spring_security_check").
-with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_username"=> connection.instance_variable_get(:@username)}).to_return(:status => 200, :headers => {'Set-Cookie' => to_cookie(@cookies)})
+    with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_username"=> connection.instance_variable_get(:@username)}).to_return(:status => 200, :headers => {'Set-Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
 
-    @stubbed_logout = stub_request(:get, "#{@base_url}/j_spring_security_logout").with(:headers => {'Cookie' => to_cookie(@cookies)})
+    @stubbed_logout = stub_request(:get, "#{@base_url}/j_spring_security_logout").with(:headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
   end
 
   describe '# initialize' do
@@ -134,6 +134,72 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
     it "should define nil cookies" do
       @conn.instance_variable_get(:@cookies).must_be_nil
     end
+
+    it "should default to verifying SSL" do
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+    end
+
+    it "should interpret boolean settings for verifying SSL" do
+      @conn.configure({:verify_ssl => true})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => false})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should interpret true|false string settings for verifying SSL" do
+      @conn.configure({:verify_ssl => 'true'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => 'false'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should use the default (true) when a weird setting is used for verifying SSL" do
+      @conn.configure({:verify_ssl => 'something weird!'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+    end
+
+    it "should interpret t|f settings for verifying SSL" do
+      @conn.configure({:verify_ssl => 't'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => 'f'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should interpret yes|no settings for verifying SSL" do
+      @conn.configure({:verify_ssl => 'yes'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => 'no'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should interpret y|n settings for verifying SSL" do
+      @conn.configure({:verify_ssl => 'y'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => 'n'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should interpret 1|0 settings for verifying SSL" do
+      @conn.configure({:verify_ssl => '1'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => '0'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should interpret T|F settings for verifying SSL" do
+      @conn.configure({:verify_ssl => 'T'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => 'F'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
+    it "should interpret Y|N settings for verifying SSL" do
+      @conn.configure({:verify_ssl => 'Y'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal true
+      @conn.configure({:verify_ssl => 'N'})
+      @conn.instance_variable_get(:@verify_ssl).must_equal false
+    end
+
   end
 
   describe '#configure_with' do
@@ -243,7 +309,7 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
     before do
       setup_configured_connection
       stub_connection_round_trip(@conn)
-      @stubbed_get = stub_request(:get, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+      @stubbed_get = stub_request(:get, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
     end
 
     it "should not open connection" do
@@ -266,7 +332,7 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
     before do
       setup_configured_connection
       stub_connection_round_trip(@conn)
-      @stubbed_get = stub_request(:get, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+      @stubbed_get = stub_request(:get, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
     end
 
     it "should open connection" do
@@ -289,7 +355,7 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
     before do
       setup_configured_connection
       stub_connection_round_trip(@conn)
-      @stubbed_get = stub_request(:delete, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+      @stubbed_get = stub_request(:delete, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
     end
 
     it "should not open connection" do
@@ -312,7 +378,7 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
     before do
       setup_configured_connection
       stub_connection_round_trip(@conn)
-      @stubbed_get = stub_request(:delete, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+      @stubbed_get = stub_request(:delete, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
     end
 
     it "should open connection" do
@@ -336,7 +402,7 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
       setup_configured_connection
       stub_connection_round_trip(@conn)
       @post_params = {'a' => 'b'}
-      @stubbed_post = stub_request(:post, "#{@base_url}/go").with(:body => @post_params).to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+      @stubbed_post = stub_request(:post, "#{@base_url}/go").with(:body => @post_params).to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
     end
 
     it "should not open connection" do
@@ -360,7 +426,7 @@ with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_u
       setup_configured_connection
       stub_connection_round_trip(@conn)
       @post_params = {'a' => 'b'}
-      @stubbed_post = stub_request(:post, "#{@base_url}/go").with(:body => @post_params).to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+      @stubbed_post = stub_request(:post, "#{@base_url}/go").with(:body => @post_params).to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)}.merge(WEBMOCK_HEADERS))
     end
 
     it "should open connection" do

data/test/test_helper.rb

@@ -8,4 +8,6 @@ require 'webmock/minitest'
 
 require File.expand_path('../../lib/nolij_web.rb', __FILE__)
 
-WebMock.disable_net_connect!
+WebMock.disable_net_connect!(:allow_localhost => true)
+
+WEBMOCK_HEADERS = {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate', 'User-Agent'=>'Ruby'}

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: nolij_web
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Shannon Henderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
 description: A Ruby wrapper for the Nolij Web API
@@ -116,7 +103,7 @@ extra_rdoc_files:
 - README.rdoc
 - LICENSE.txt
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -146,31 +133,30 @@ files:
 homepage: https://github.com/reed-college/nolij_web/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --line-numbers
-- --inline-source
-- --main
+- "--line-numbers"
+- "--inline-source"
+- "--main"
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Interact with Nolijweb's REST API
 test_files:
 - test/nolij_web/attribute_missing_error_test.rb