filebound_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98614285d4e91599c7a5d4b7e55ad3fe2ebc9836bd945cf35ea1d8ce8d3ba91d
+  data.tar.gz: '09ed3d8df8de9172e02464cd22361c9c8bfb5f8bdfd48293eeed859b780ccf39'
+SHA512:
+  metadata.gz: 52fe4ac525d97b95b5589e86b8d37be2117a2169a629a8e1d5b4d2159c2281fd2c79c9b1f5e2909162699a23104636a7f55ad4ffeac23689d10dc4886fd6a2f6
+  data.tar.gz: a92d599d4670123d4f4b680548e751ea2c20aa32e1f1cc2d4fc105866c1088b61075bd31cfc880844ef5c055b7e41dc435fd8835a1208c70e025f57ae7d9b887

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test.yml
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+
+Changes to this gem will be noted here.
+
+## [0.1.0] - 2018-08-01
+### Added
+- Assignments, Dividers, DocumentBinaryData, Documents, EFormData, EFormDetail, Files, Projects, Separators, and Version
+  endpoints.
+- Initial build of client and configuration code
+- Specs for assignments, dividers, documents, projects, and separators endpoints and FileboundClient::Client.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@heiskell.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to the Filebound Client Gem
+
+Thank you for taking the time to contribute to this project!  We gladly welcome new suggestions and pull requests!
+
+This document details the guidelines around contributing to this gem.  If anything is vague or unclear let us know or
+submit a pull request with your suggested changes!  Again these are guidelines and not hard and fast rules so please use
+your discretion.
+
+## Code of Conduct
+
+You can access our code of conduct [here](./CODE_OF_CONDUCT.md).  It is based on the 
+[Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct.  Please report conduct that violates
+this code to [dev@heiskell.com](mailto:dev@heiskell.com).
+
+## Contributing
+
+### Reporting Bugs
+
+Coming soon...
+
+#### Submitting A Good Bug Report
+
+Coming soon...
+
+### Suggesting Enhancements
+
+Coming soon...
+
+#### Submitting a Good Enhancement Suggestion
+
+Coming soon...
+
+### Pull Requests
+
+Coming soon...
+
+## Styleguides
+
+Coming soon...
+
+### Commit Messages
+
+Coming soon...
+
+### Ruby Styleguide
+
+Coming soon...
+
+### Specs Styleguide
+
+Coming soon...
+
+### Documentation Styleguide
+
+Coming soon...
+
+
+

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in filebound_client.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', '~> 3.0'
+end
+
+group :development do
+  gem 'rubocop', '~> 0.58.2', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    filebound_client (0.1.0)
+      ruby-ntlm (~> 0.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      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)
+    unicode-display_width (1.4.0)
+    yard (0.9.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.0)
+  filebound_client!
+  rake (~> 12.3.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.58.2)
+  yard (~> 0.9.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 J.D. Heiskell & Co.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,200 @@
+# FileboundClient
+
+This gem provides a easy way for you to access the Filebound API.
+
+## Dependencies
+
+### Development
+* Ruby
+* Bundler
+* Rake
+* Yard - for documentation
+* RSpec - for testing
+
+### 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filebound_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filebound_client
+
+## Usage
+
+Once you have the gem install you will need to configure it before you can connect to the Filebound API.  
+Here is an example:
+
+```ruby
+require 'filebound_client'
+c = FileboundClient::Client.connect(host: url_to_api, username: fb_username, password: fb_password)
+```
+
+If your Filebound server uses domain auth you will need to add some additional configuration values:
+
+```ruby
+require 'filebound_client'
+c = FileboundClient::Client.connect(host: url_to_api, username: fb_username, password: fb_password, use_ntlm: true, 
+                                    ntlm_user: ntlm_username, ntlm_password: ntlm_password, ntlm_domain: ntlm_domain)
+```
+
+Once you have a connection you can start making requests to the API
+
+## Examples
+
+### Get a project
+
+```ruby
+p = c.project(123)
+puts p[:name]
+```
+
+### Create a project
+
+```ruby
+p = c.project_new
+p[:name] = 'Test Project'
+project_id = c.project_add(p)
+p = c.project(project_id)
+puts p[:name]
+```
+
+### Update a project
+
+```ruby
+p = c.project(123)
+puts p[:name]
+p[:name] = 'something else'
+project_id = c.project_update(p)
+p = c.project(project_id)
+puts p[:name]
+```
+
+### Create a file
+
+```ruby
+p = c.project(123)
+f = c.file_new
+f[:projectId] = p[:id]
+f[:notes] = 'test file'
+```
+
+If you have field values you need to set for indexing set them this way.  The first element in the array is not used.  
+Element 1 is the first indexed field.
+
+```ruby
+f[:field] = ["not used - ignore", "test value", "", "", "", "", "", "", "", "", "", "", "", "", 
+             "", "", "", "", "", "", ""]
+```
+
+Then save your new file this way.
+
+```ruby
+file_id = c.file_add(f)
+f = c.file(file_id)
+puts f[:notes]
+```
+
+### Update a file
+
+```ruby
+f = c.file(123)
+f[:notes] = 'updated notes'
+file_id = c.file_update(f)
+f = c.file(file_id)
+puts f[:notes]
+```
+
+### Create document with attached binary file data
+
+```ruby
+data = Base64.encode64(File.read('somefile.pdf'))
+d = c.document_new
+d[:allowSaveBinaryData] = false
+d[:binaryData] = data
+d[:extension] = 'pdf'
+d[:fileId] = 123
+d[:description] = 'Test PDF file'
+d[:name] = 'somefile.pdf'
+d[:notes] = 'Test PDF'
+document_id = c.document_add(d)
+d = c.document(document_id)
+puts d[:name]
+```
+
+Set the isImage field to true if the file is an image (png, jpg, gif, etc).
+Set the isText field to true if the file is a text file.
+Set the isTIFF field to true if the file is as TIFF file.
+Set the isWeb field to true if the file is and HTML file (HTM, HTML, etc).
+Set the isWebEform field to true if the file is an HTML form.
+
+### Update document
+
+```ruby
+d = c.document(123)
+puts d[:name]
+d[:name] = 'different name'
+document_id = c.document_update(d)
+d = c.document(document_id)
+puts d[:name]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Setup your Filebound connection information
+in a test.yml file.  You can see an example in example_test.yml.  Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the 
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### New resource endpoints
+
+If you are creating a new resource endpoint there are a couple of macros you can use for creating a new empty
+resource and getting all instances of a resource on the Filebound server.  Here is an example from the assignments 
+resource endpoint file:
+
+```ruby
+module FileboundClient
+  module Endpoints
+    module Assignments
+      def self.included klass
+        klass.instance_eval do
+          allow_new :assignment  # Creates a new empty assignment
+          allow_all :assignments # Request all assignments with an optional filter query parameter
+        end
+      end
+      ...
+    end
+  end
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JDHeiskell/filebound_client.  Our contributing
+guidelines can be found [here](./CONTRIBUTING.md).
+
+## Code of Conduct
+
+We enforce the standard [Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct.  You can access
+that [here](./CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). A copy
+of it is [here](./LICENSE.txt).