filestack 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b3b093fe7eae680b13972846a86be9016c55351
+  data.tar.gz: f0e172f275625c9e04cc05f58116ca118a0e8eb8
+SHA512:
+  metadata.gz: a00a0fcfec665e2318360a48e2d36e3f2b3ff1d32a0c276250282428558b6c7a79743eae6208d160108d18f26a46c47eb5ca734068d693fd3f6f7df2797b6e7d
+  data.tar.gz: 2fcb37269340045dff079d821b2eb8b80c58610ef968a564178126355bba44c134ad6278c1d63748c25e448db670d96c8a2af6abc7bad98379b44ec4caf66846

data/.gitignore

@@ -0,0 +1,18 @@
+*.DS_Store
+*.gem
+*.rbc
+*.bundle
+.rspec_status
+
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  
+after_success:
+  - coveralls

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Filestack-Ruby Changelog
+
+## 2.0.0
+- First release, includes uploads, transformations, conversions and tagging

data/CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contributing to Filestack Ruby SDK
+
+First of all, thank you so much for being interested in contributing to Filestack Ruby SDK. This document will guide you through this process. You can contribute in different ways:
+
+- Reporting issues
+- Fixing bugs or developing new features
+- Creating new examples
+
+## Issues
+Feel free to open new issues or participating in the discussion of the existing ones on
+[this repository](https://github.com/filestack/filestack-ruby/issues), but before doing so, please make sure that the issue is not duplicated and/or the discussion is related to the topic of the issue.
+
+## Pull requests
+Code contributions are welcome following a process which guarantees the long-term maintainability of the project.
+You can contribute either with bugfixes or new features. Before submitting a new feature, we highly encourage you to first open a new issue describing its motivation and details and discuss it with one of the project mantainers. This will ensure that the feature fits well in the project.
+
+### Step 1: Open a new issue (if not opened yet)
+Before starting to code, it is desirable to first open an issue describing the bug or the new feature. Please be sure the issue is not duplicated.
+
+### Step 2: Fork the repository
+Fork the project https://github.com/filestack/filestack-ruby into your account. Then, check out your copy of the project locally.
+```
+git clone git@github.com:user/filestack/filestack-ruby.git
+cd filestack-ruby
+git remote add upstream https://github.com/filestack/filestack-ruby.git
+```
+
+### Step 3: Create a new feature branch `contrib/issue-number`
+Put your code in a new feature branch. The name of the new branch should start with `contrib/`. This convention will help us to keep track of future changes from pull requests.
+```
+git checkout -b contrib/issue-number tags/tag-number
+```
+Note that tags/tag-number would correspond with any of the tags (for example 1.0.X). For example, suppose that the latest version of the project is v1.0.0 and you want to fix a new bug that you discovered in this version. If the new reported issue has an id, say, #186, then you would create your feature branch in this way:
+```
+git checkout -b contrib/issue-186 tags/1.0.X
+```
+
+### Step 4: Committing your changes
+First of all, make sure that git is configured with your complete name and email address. It is desirable to use the same email of your Github account, this will help to identify the contributions:
+```
+git config --global user.name "Your Name"
+git config --global user.email "your@email.com"
+```
+Write a good commit message. It should describe the changes you made and its motivation. Be sure to reference the issue you are working in the commit that finishes your contribution using one the [keywords to close issues in Github](https://help.github.com/articles/closing-issues-via-commit-messages/).
+If your commit message is too long, try to summarize the changes in the header of the message, like this:
+```
+fix #xx : summarize your commit in one line
+
+If needed, explain more in detail the changes introduced in your
+commit and the motivation. You could introduce some background
+about the issue you worked in.
+
+This message can contain several paragraphs and be as long as
+you need, but try to do a good indentation: the columns should
+be shorter than 72 characters and with a proper word-wrap.
+The command `git log` will print this complete text in a nice
+way if you format it properly.
+```
+The header and the body of the commit message must be separated by a line in blank. The header is the message shown when running the command `git shortlog`.
+
+#### Test your code
+Verify that your changes are actually working by adding the required unit tests. It is desirable to include unit test covering all new features you implement. Also, if you find a bug which is not currently detected by the unit tests you might consider to implement a new one or modify the current implementation. After this, you can verify that everything works fine after your changes with:
+
+```
+rake
+```
+
+### Step 5: Push your changes
+
+Push your changes to your forked project with:
+```
+git push origin contrib/issue-186
+```
+
+### Step 6: Create and submit a pull request
+Go to your forked project on GitHub, select your feature branch and click the “Compare, review, create a pull request button”.
+
+
+### License Agreement
+By contributing your code, you agree to license your contribution under the terms of the [Apache 2.0 license](https://raw.githubusercontent.com/citiususc/hipster/4ca93e681ad7335acbd0bea9e49fe678d56f3519/LICENSE).
+
+Also, remember to add this header to each new file that you’ve created:
+
+```
+Copyright 2017 Filestack
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in filestack-ruby.gemspec
+gemspec
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    filestack (2.0.0)
+      mimemagic (~> 0.3.2)
+      parallel (~> 1.11.2)
+      unirest (~> 1.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (1.8.3)
+    mime-types (1.25.1)
+    mimemagic (0.3.2)
+    parallel (1.11.2)
+    rake (10.5.0)
+    rest-client (1.6.9)
+      mime-types (~> 1.16)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    unirest (1.1.2)
+      addressable (~> 2.3.5)
+      json (~> 1.8.1)
+      rest-client (~> 1.6.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  filestack!
+  rake
+  rspec (~> 3.0)
+  simplecov (~> 0.14)
+
+BUNDLED WITH
+   1.15.1

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,148 @@
+[![Travis CI][travis_ci_badge]][travis_ci]
+[![Coveralls][coveralls_badge]][coveralls]
+[![Code Climate][code_climate_badge]][code_climate]
+
+# Filestack Ruby SDK
+<a href="https://www.filestack.com"><img src="https://filestack.com/themes/filestack/assets/images/press-articles/color.svg" align="left" hspace="10" vspace="6"></a>
+This is the official Ruby SDK for Filestack - API and content management system that makes it easy to add powerful file uploading and transformation capabilities to any web or mobile application.
+
+## Resources
+
+* [Filestack](https://www.filestack.com)
+* [Documentation](https://www.filestack.com/docs)
+* [API Reference](https://filestack.github.io/)
+
+## Installing
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filestack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filestack-ruby
+
+## Usage
+
+```ruby
+require 'filestack'
+```
+Intialize the client using your API key, and security if you are using it. 
+```ruby
+client = Client.new('YOUR_API_KEY', security: security_object)
+```
+### Uploading
+Filestack uses multipart uploading by default, which is faster for larger files. This can be turned off by passing in ```multipart: false```. Multipart is disabled when uploading external URLs. 
+```ruby
+filelink = client.upload(filepath: '/path/to/file')
+
+# OR
+
+filelink = client.upload(external_url: 'http://someurl.com')
+```
+
+### Security
+If security is enabled on your account, or if you are using certain actions that require security (delete, overwrite and certain transformations), you will need to create a security object and pass it into the client on instantiation. 
+
+```ruby
+security = FilestackSecurity.new('YOUR_APP_SECRET', options: {call: %w[read store pick]})
+client = client.new('YOUR_API_KEY', security: security)
+```
+
+### Using Filelinks
+Filelink objects are representation of a file handle. You can download, get raw file content, delete and overwrite file handles directly. Security is required for overwrite and delete methods. 
+
+### Transformations 
+Transforms can be initiated one of two ways. The first, by calling ```transform``` on a filelink:
+
+```ruby
+transform = filelink.transform
+```
+
+Or by using an external URL via the client:
+
+```ruby
+transform = client.convert_external('https://someurl.com')
+```
+
+Transformations can be chained together as you please.
+
+```ruby
+transform = filelink.transform.resize(width: 100, height: 100).flip.enhance
+```
+
+You can retrieve the URL of a transform object:
+
+```ruby
+transform.url
+```
+
+Or you can store (upload) the transformation as a new filelink:
+
+```ruby
+new_filelink = transform.store()
+```
+
+For a list of valid transformations, please see [here](https://www.filestack.com/docs/image-transformations).
+
+### Tagging
+
+If you have auto-tagging enabled onto your account, it can be called on any filelink object (tags don't work on external URLs).
+
+```ruby
+tags = filelink.tags
+```
+
+This will return a hash with labels and their associated confidence:
+
+```ruby
+{
+    "auto" => {
+        "art"=>73,
+        "big cats"=>79,
+        "carnivoran"=>80,
+        "cartoon"=>93,
+        "cat like mammal"=>92,
+        "fauna"=>86, "mammal"=>92, 
+        "small to medium sized cats"=>89, 
+        "tiger"=>92,
+        "vertebrate"=>90},
+    "user" => nil
+}
+```
+
+SFW is called the same way, but returns a boolean value (true == safe-for-work, false == not-safe-for-work). 
+
+```ruby
+sfw = transform.sfw
+``` 
+
+## Versioning
+
+Filestack Ruby SDK follows the [Semantic Versioning](http://semver.org/).
+
+## Issues
+
+If you have problems, please create a [Github Issue](https://github.com/filestack/filestack-ruby/issues).
+
+## Contributing
+
+Please see [CONTRIBUTING.md](https://github.com/filestack/filestack-ruby/CONTRIBUTING.md) for details.
+
+## Credits
+
+Thank you to all the [contributors](https://github.com/filestack/filestack-ruby/graphs/contributors).
+
+[travis_ci]: http://travis-ci.org/filestack/filestack-ruby
+
+[travis_ci_badge]: https://travis-ci.org/filestack/filestack-ruby.svg?branch=master		
+[code_climate]: https://codeclimate.com/github/filestack/filestack-ruby		
+[code_climate_badge]: https://codeclimate.com/github/filestack/filestack-ruby.png		
+[coveralls]: https://coveralls.io/github/filestack/filestack-ruby?branch=master		
+[coveralls_badge]: https://coveralls.io/repos/github/filestack/filestack-ruby/badge.svg?branch=master