filebound_client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7cb48474b62921efc99c473e43a5176fa9656f4d93909aa1583ff367e13f32
-  data.tar.gz: ce0a1ca7de55a7945a2fceee13bdec8081d76cd8d834e18927c96db426a173f2
+  metadata.gz: 5430818e9e9bb023e023b877145a3ad2d49e34faa526095eeca9d539570d0424
+  data.tar.gz: c96ef4679daf8250c0917de85c671c68e3e831605f2e7018e3b7200f58af0839
 SHA512:
-  metadata.gz: 00a8e448b5442b217e9eb89c849846fa34b1124fe82a90e459a428e194e83bf566ac702217209cc242e5c235ba745115bcb784c7e0c76536f9a0a65346fe3889
-  data.tar.gz: 425e0c2a93b085e06c55ab42b0716501dad591bb8552bd1946fee2ab76e566e56839d1331c48b8605f56fc4cced25f336a0851f3077f9f038d1ca033b38f939c
+  metadata.gz: '09da2bf6aa663fd2be1f91883406fca201ed71de8958762fe3ea90575d925d58651c4d8848a02c9ea9a7c228797efb0cc6c55676bf42ab00b06b7e16deb5fc95'
+  data.tar.gz: 7da1a67a86028ce37f3373dfd4839db06288a30bad281a6e3a77b99210bb78db8ae5dcb1d86671c6ad43f5ca04c593a689049e5801f6476b87df65e024842cfd

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
+
+*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
+
+Please provide enough information so that others can review your pull request:
+
+Explain the **details** for making this change. What existing problem does the pull request solve?
+
+**Test plan (required)**
+
+Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
+
+Write your test code using RSpec.
+
+This gem requires a connection to a test Filebound server to run specs.  We expect all specs to pass when we run them against our local test Filebound server.  Travis CI won't run the specs because we don't have access to a Filebound server within the Travis servers but we need to be able to run the specs locally where we do have access to a Filebound test server.  It would be helpful if you let us know what version of the Filebound API you were using to run your specs against as well just in case there are compatibility issues.
+
+**Code formatting**
+
+Lint you code through Rubocop and fix any issues that come up before submitting the PR.
+
+**Closing issues**
+
+Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).

data/.travis.yml

@@ -1,5 +1,19 @@
-sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d
 language: ruby
 rvm:
   - 2.5.1
-before_install: gem install bundler -v 1.16.2
+before_install: 
+  - gem install bundler
+  - bundle --version
+install:
+  - bundle install
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script: skip
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 
 Changes to this gem will be noted here.
 
+## [0.2.0] - 2018-08-07
+### Changed
+- Replaced ruby-ntlm dependency with httpi.  httpi gem is actively being developed while ruby-ntlm hasn't had a new
+  release in over a year.
+
+### Added
+- Query resource endpoint.
+
 ## [0.1.1] - 2018-08-01
 ### Fixed
 - Fixed error in summary in the gemspec file.

data/CONTRIBUTING.md

@@ -16,43 +16,75 @@ this code to [dev@heiskell.com](mailto:dev@heiskell.com).
 
 ### Reporting Bugs
 
-Coming soon...
+Thank you for reporting those pesky bugs!
+
+In order for us to effectively reproduce and therefore fix the bug we need a "good" bug report submitted by you.
+All bug reports can be submitted by going to the Issues tab in GitHub and clicking "New Issue".
 
 #### Submitting A Good Bug Report
 
-Coming soon...
+So what is meant by a good bug report?  Well first of all please use GitHub's built in issue tracking by going to 
+the issues tab and clicking "New Issue".  Then please use [this document](.github/ISSUE_TEMPLATE/bug_report.md) as the template for submitting the report.
+Following this template should hopefully give us enough information to reproduce and fix the issue you have discovered.
+Thank you!
 
 ### Suggesting Enhancements
 
-Coming soon...
+We always welcome enhancement suggestions!  Making this software better is a high priority so thank you for any suggestions you may have!  Given that we do have some guidelines to follow when making enhancement suggestions.
 
 #### Submitting a Good Enhancement Suggestion
 
-Coming soon...
+Submitting a good enhancement suggestion is key to making this software do what it is intended to do with minimal technical debt and to properly test the functionality.  
+
+Enhancement suggestions can be submitted through GitHub using the built-in issue tracking.  All issues opened for enhancements should be tagged as such to differentiate them from bug reports.  Please use [this document](.github/ISSUE_TEMPLATE/feature_request.md) as the template for submitting an enhancement suggestion.
 
 ### Pull Requests
 
-Coming soon...
+If you would like to contribute to the project, great! Thank you for taking the time to work on this project! Given that it is important to let us know some information about the code and what feature or problem you are submitting the request for.  Please use [this document](.github/PULL_REQUEST_TEMPLATE.md) as a template for submitting your PR and again, thank you!
 
 ## Styleguides
 
-Coming soon...
+Please follow these style guides when submitting code to this project.  It helps for readability and productivity if everyone is on the same page with how code and commits are supposed to be formatted.
 
 ### Commit Messages
 
-Coming soon...
+We use this git commit style guide suggested by Tim Pope - https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+```
+Capitalized, short (50 chars or less) summary
+
+More detailed explanatory text, if necessary.  Wrap it to about 72
+characters or so.  In some contexts, the first line is treated as the
+subject of an email and the rest of the text as the body.  The blank
+line separating the summary from the body is critical (unless you omit
+the body entirely); tools like rebase can get confused if you run the
+two together.
+
+Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
+or "Fixes bug."  This convention matches up with commit messages generated
+by commands like git merge and git revert.
+
+Further paragraphs come after blank lines.
+
+- Bullet points are okay, too
+
+- Typically a hyphen or asterisk is used for the bullet, followed by a
+  single space, with blank lines in between, but conventions vary here
+
+- Use a hanging indent
+```
 
 ### Ruby Styleguide
 
-Coming soon...
+Please lint all code through Rubocop using the .rubocop.yml file in the root of this repository before submitting a PR.
 
 ### Specs Styleguide
 
-Coming soon...
+Please lint your spec code through Rubocop using .rubocop.yml as well.
 
 ### Documentation Styleguide
 
-Coming soon...
+We use YARD for document generation so please use the conventions stated at https://yardoc.org.  Make sure all public interfaces are documented and parameters and return values are in that documentation.
 
 
 

data/Gemfile.lock

@@ -1,19 +1,24 @@
 PATH
   remote: .
   specs:
-    filebound_client (0.1.1)
-      ruby-ntlm (~> 0.0.4)
+    filebound_client (0.2.0)
+      httpi (~> 2.4.0)
+      rubyntlm (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
+    httpi (2.4.3)
+      rack
+      socksify
     jaro_winkler (1.5.1)
     parallel (1.12.1)
     parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    rack (2.0.5)
     rainbow (3.0.0)
     rake (12.3.1)
     rspec (3.7.0)
@@ -37,8 +42,9 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-ntlm (0.0.4)
     ruby-progressbar (1.9.0)
+    rubyntlm (0.6.2)
+    socksify (1.7.1)
     unicode-display_width (1.4.0)
     yard (0.9.15)
 

data/README.md

@@ -2,6 +2,8 @@
 
 This gem provides a easy way for you to access the Filebound API.
 
+[![Build Status](https://travis-ci.org/JDHeiskell/filebound_client.svg?branch=master)](https://travis-ci.org/JDHeiskell/filebound_client)
+
 ## Dependencies
 
 ### Development
@@ -13,8 +15,9 @@ This gem provides a easy way for you to access the Filebound API.
 
 ### Runtime
 * Ruby
-* ruby-ntlm - this gem provides the ability to send NTLM headers in requests for when your Filebound server is running
-              on an IIS web site with Windows Authentication enabled.
+* httpi - this gem provides the ability to send NTLM headers in requests for when your Filebound server is running
+          on an IIS web site with Windows Authentication enabled.
+* rubyntlm - this gem is required by the httpi gem to support NTLM headers
 
 ## Installation
 

data/filebound_client.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3.0'
   spec.add_development_dependency 'yard', '~> 0.9.0'
 
-  spec.add_runtime_dependency 'ruby-ntlm', '~> 0.0.4'
+  spec.add_runtime_dependency 'httpi', '~> 2.4.0'
+  spec.add_runtime_dependency 'rubyntlm', '~> 0.6.0'
 end

data/lib/filebound_client.rb

@@ -94,7 +94,7 @@ module FileboundClient
     def perform(action, url, params)
       response = connection.send(action, url, params)
       # rubocop:disable Metrics/LineLength
-      raise FileboundClientException.new("#{action.upcase} request failed: #{response.code}", response.code) unless response.code == '200'
+      raise FileboundClientException.new("#{action.upcase} request failed: #{response.code}", response.code) unless response.code == 200
       # rubocop:enable Metrics/LineLength
       response.body
     end

data/lib/filebound_client/connection.rb

@@ -1,6 +1,6 @@
-require 'ntlm/http'
 require 'filebound_client/config'
 require 'json'
+require 'httpi'
 
 module FileboundClient
   # Encapsulates low level logic to talk to Filebound server
@@ -30,6 +30,7 @@ module FileboundClient
         # rubocop:disable Metrics/LineLength
         c.ntlm_auth = { user: config[:ntlm_user], password: config[:ntlm_password], domain: config[:ntlm_domain] } if config[:use_ntlm]
         # rubocop:enable Metrics/LineLength
+        HTTPI.adapter = :net_http
       end
     end
 
@@ -102,8 +103,8 @@ module FileboundClient
     # @param [Hash] params the params Hash that will be sent in the request (keys: query, headers, body)
     # @return [Net::HTTPResponse] the response from the GET request
     def get(url, params)
-      request = Net::HTTP::Get.new(resource_url(url, query_params(params[:query])))
-      execute_request(request, params)
+      request = HTTPI::Request.new(resource_url(url, query_params(params[:query])))
+      execute_request(:get, request, params)
     end
 
     # Sends a PUT request to the supplied resource using the supplied params hash
@@ -111,9 +112,9 @@ module FileboundClient
     # @param [Hash] params the params Hash that will be sent in the request (keys: query, headers, body)
     # @return [Net::HTTPResponse] the response from the PUT request
     def put(url, params)
-      request = Net::HTTP::Put.new(resource_url(url, query_params(params[:query])))
+      request = HTTPI::Request.new(resource_url(url, query_params(params[:query])))
       request.body = params[:body].to_json
-      execute_request(request, params)
+      execute_request(:put, request, params)
     end
 
     # Sends a POST request to the supplied resource using the supplied params hash
@@ -121,9 +122,9 @@ module FileboundClient
     # @param [Hash] params the params Hash that will be sent in the request (keys: query, headers, body)
     # @return [Net::HTTPResponse] the response from the POST request
     def post(url, params)
-      request = Net::HTTP::Post.new(resource_url(url, query_params(params[:query])))
+      request = HTTPI::Request.new(resource_url(url, query_params(params[:query])))
       request.body = params[:body].to_json
-      execute_request(request, params)
+      execute_request(:post, request, params)
     end
 
     # Sends a DELETE request to the supplied resource using the supplied params hash
@@ -131,8 +132,8 @@ module FileboundClient
     # @param [Hash] params the params Hash that will be sent in the request (keys: query, headers, body)
     # @return [Net::HTTPResponse] the response from the DELETE request
     def delete(url, params)
-      request = Net::HTTP::Delete.new(resource_url(url, query_params(params[:query])))
-      execute_request(request, params)
+      request = HTTPI::Request.new(resource_url(url, query_params(params[:query])))
+      execute_request(:delete, request, params)
     end
 
     # Sends a POST request to the Filebound API's login endpoint to request a new security token
@@ -140,7 +141,7 @@ module FileboundClient
     def login
       response = post('/login', body: { username: configuration.username, password: configuration.password },
                                 headers: { 'Content-Type' => 'application/json' })
-      if response.is_a?(Net::HTTPSuccess)
+      if response.code == 200
         @token = JSON.parse(response.body, symbolize_names: true)
         true
       else
@@ -151,9 +152,9 @@ module FileboundClient
     private
 
     def resource_url(url, query)
-      return "#{api_base_uri}/#{url.reverse.chomp('/').reverse}" unless query
+      return "http://#{host}#{api_base_uri}/#{url.reverse.chomp('/').reverse}" unless query
       query_string = query.map { |k, v| "#{k}=#{v}" }.join('&')
-      "#{api_base_uri}/#{url.reverse.chomp('/').reverse}?#{query_string}"
+      "http://#{host}#{api_base_uri}/#{url.reverse.chomp('/').reverse}?#{query_string}"
     end
 
     def query_params(params)
@@ -167,17 +168,16 @@ module FileboundClient
     def set_headers(request, headers)
       if headers.respond_to?(:to_hash)
         headers.each do |k, v|
-          request[k.to_s] = v.to_s
+          request.headers[k.to_s] = v.to_s
         end
       end
       request
     end
 
-    def execute_request(request, params)
-      http = Net::HTTP.new(configuration.host)
+    def execute_request(method, request, params)
       request = set_headers(request, params[:headers])
-      request.ntlm_auth(ntlm_user, ntlm_domain, ntlm_password) if configuration.ntlm_auth
-      http.request(request)
+      request.auth.ntlm(ntlm_user, ntlm_password, ntlm_domain) if configuration.ntlm_auth
+      HTTPI.request(method, request)
     end
   end
 end

data/lib/filebound_client/endpoints.rb

@@ -7,6 +7,7 @@ require 'filebound_client/endpoints/dividers'
 require 'filebound_client/endpoints/document_binary_data'
 require 'filebound_client/endpoints/eform_data'
 require 'filebound_client/endpoints/separators'
+require 'filebound_client/endpoints/query'
 
 module FileboundClient
   # Module for resource endpoints
@@ -45,6 +46,7 @@ module FileboundClient
         include FileboundClient::Endpoints::DocumentBinaryData
         include FileboundClient::Endpoints::EFormData
         include FileboundClient::Endpoints::Separators
+        include FileboundClient::Endpoints::Query
       end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/lib/filebound_client/endpoints/query.rb

@@ -0,0 +1,17 @@
+module FileboundClient
+  module Endpoints
+    # Module for Query resource endpoint
+    module Query
+      # Runs a query against the API using the project, files and documents query supplied.
+      # See https://applications.filebound.com/v3/documentation/endpoints#Custom+Query for more detail.
+      # @param [String] projects_query the comma-delimited projects query, pass 'all' for no filter (ex: name_Invoices)
+      # @param [String] files_query the comma-delimited files query, pass 'all' for no filter (ex: status_1)
+      # @param [String] documents_query the comma-delimited documents query, pass 'all' for no filter (ex: divider_HR)
+      # @example Get project named Invoices with Files that have a status of 1 and documents with a divider named HR
+      #   query('name_Invoices','status_1','divider_HR')
+      def query(projects_query, files_query, documents_query, query_params = nil)
+        get("/query/#{projects_query}/#{files_query}/#{documents_query}", query_params)
+      end
+    end
+  end
+end

data/lib/filebound_client/version.rb

@@ -1,4 +1,4 @@
 module FileboundClient
   # Current version of gem
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filebound_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bryan Richardson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: ruby-ntlm
+  name: httpi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: rubyntlm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: 
 email:
 - brichardson@heiskell.com
@@ -73,6 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -104,6 +121,7 @@ files:
 - lib/filebound_client/endpoints/eform_detail.rb
 - lib/filebound_client/endpoints/files.rb
 - lib/filebound_client/endpoints/projects.rb
+- lib/filebound_client/endpoints/query.rb
 - lib/filebound_client/endpoints/separators.rb
 - lib/filebound_client/endpoints/version.rb
 - lib/filebound_client/version.rb