filestack 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45d7aacf132ef3dd705c669d129953249290d022
-  data.tar.gz: 31b9263afe6b70daddfeebfc24f817d84b1bc1fd
+  metadata.gz: 1aca602e4b1ed4c8301e92f48c720770f342b4bd
+  data.tar.gz: abaf50f6a4ee02a26d122d6276506a73ef29cdb0
 SHA512:
-  metadata.gz: 784bc62bdabfeccfeebae6a7383dd3dd4ea5cec831deb9706b4a29293a0246e6253f60838163cb133e8f0bd3bd1594891c28a981fdbe465d5e27862b31c58473
-  data.tar.gz: 39cadb89c3e116b119e88f3960cf4d98236c6ca0cdc2dba7ce85f56833011b602c12fad0f3110d87dee3a91cc8f115b7d4919aae19f5dc5136756f4170e2f2b1
+  metadata.gz: 84fcb737a31a173e11858547521f33e3bff386f782e01e7434508e80847ee6f8a47fceaebb189ebdb1a8408593d03fb0e4c0558d1a003bd46dde3b254ee5df7f
+  data.tar.gz: 702dfee5fd7a8f1186b45802a48a5a7a27e9dad43e6539baceb82595f9aa8e38e547a014ad9f3b93cbc082bd85096a07082e62c5a9cdd01896867e37f344f527

data/.gitignore

@@ -3,6 +3,7 @@
 *.rbc
 *.bundle
 .rspec_status
+Gemfile.lock
 
 /.config
 /coverage/

data/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Filestack-Ruby Changelog
 
-## 2.0.0
-- First release, includes uploads, transformations, conversions and tagging
+## 2.1.0 (August 4, 2017)
+- FS-1452 Rename Client to FilestackClient, Filelink to FilestackFilelink
 
 ## 2.0.1 (July 11, 2017)
-- FS-1389 Fix import error when calling './lib' in client class
+- FS-1389 Fix import error when calling './lib' in client class
+
+## 2.0.0
+- First release, includes uploads, transformations, conversions and tagging

data/README.md

@@ -30,12 +30,16 @@ Or install it yourself as:
 
 ## Usage
 
+## IMPORTANT
+
+A recent change (2.1.0) has renamed the Client to FilestackClient, and the Filelink to FilestackFilelink. Please make neccessary changes before upgrading to newest release if you run 2.0.1 or 2.0.0. This was to address namespace concerns by users with models and attributes named Client, and to be more consistent. 
+
 ```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)
+client = FilestackClient.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. 
@@ -52,11 +56,11 @@ If security is enabled on your account, or if you are using certain actions that
 
 ```ruby
 security = FilestackSecurity.new('YOUR_APP_SECRET', options: {call: %w[read store pick]})
-client = client.new('YOUR_API_KEY', security: security)
+client = FilestackClient.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. 
+### Using FilestackFilelinks
+FilestackFilelink 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:

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.1.0

data/filestack-ruby.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "parallel", "~> 1.11.2"
   spec.add_dependency "mimemagic", "~> 0.3.2"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.14"

data/lib/filestack/models/filelink.rb

@@ -7,14 +7,14 @@ require 'filestack/mixins/filestack_common'
 # This class represents a file stored on your Filestack
 # storage.  Once initialized, you may perform transformations, conversions,
 # get metadata, update, or delete it.
-class Filelink
+class FilestackFilelink
   include FilestackCommon
   include UploadUtils
   attr_reader :handle, :apikey, :security
 
-  # Initialize Filelink
+  # Initialize FilestackFilelink
   #
-  # @param [String]             file_handle   The Filelink handle
+  # @param [String]             file_handle   The FilestackFilelink handle
   # @param [String]             apikey        Your Filestack API Key (optional)
   # @param [FilestackSecurity]  security      Filestack security object, if
   #                                           security is enabled.
@@ -31,7 +31,7 @@ class Filelink
     send_get_content(url)
   end
 
-  # Download Filelink
+  # Download FilestackFilelink
   #
   # @param [String]              filepath     The local destination of the
   #                                           downloaded filelink
@@ -78,7 +78,7 @@ class Filelink
     send_tags('sfw', @handle, @security)
   end
 
-  # Get the URL of the Filelink
+  # Get the URL of the FilestackFilelink
   #
   # @return [String]
   def url

data/lib/filestack/models/filestack_av.rb

@@ -15,12 +15,12 @@ class AV
 
   # Turns AV into filelink if video conversion is complete
   #
-  # @return [Filestack::Filelink]
+  # @return [Filestack::FilestackFilelink]
   def to_filelink
     return 'Video conversion incomplete' unless status == 'completed'
     response = UploadUtils.make_call(@url, 'get').body
     handle = response['data']['url'].split('/').last
-    Filelink.new(handle, apikey: @apikey, security: @security)
+    FilestackFilelink.new(handle, apikey: @apikey, security: @security)
   end
 
   # Checks the status of the video conversion

data/lib/filestack/models/filestack_client.rb

@@ -2,16 +2,16 @@ require 'filestack/utils/multipart_upload_utils'
 require 'filestack/models/filestack_transform'
 require 'filestack/utils/utils'
 
-# The Filestack Client class acts as a hub for all
+# The Filestack FilestackClient class acts as a hub for all
 # Filestack actions that do not require a file handle, including
 # uploading files (both local and external), initiating an external
 # transformation, and other tasks
-class Client
+class FilestackClient
   include MultipartUploadUtils
   include UploadUtils
   attr_reader :apikey, :security
 
-  # Initialize Client
+  # Initialize FilestackClient
   #
   # @param [String]               apikey        Your Filestack API key
   # @param [FilestackSecurity]    security      A Filestack security object,
@@ -28,7 +28,7 @@ class Client
   #                                                    (Default: true)
   # @param [Hash]                 options          User-supplied upload options
   #
-  # return [Filestack::Filelink]
+  # return [Filestack::FilestackFilelink]
   def upload(filepath: nil, external_url: nil, multipart: true, options: nil, storage: 's3')
     if filepath && external_url
       return 'You cannot upload a URL and file at the same time'
@@ -45,7 +45,7 @@ class Client
                    storage: storage
                  )
                end
-    Filelink.new(response['handle'], security: @security, apikey: @apikey)
+    FilestackFilelink.new(response['handle'], security: @security, apikey: @apikey)
   end
 
   def transform_external(external_url)

data/lib/filestack/models/filestack_transform.rb

@@ -74,14 +74,14 @@ class Transform
 
   # Stores a transformation URL and returns a filelink
   #
-  # @return [Filestack::Filelink]
+  # @return [Filestack::FilestackFilelink]
   def store
     @transform_tasks.push(
       add_transform_task('store', {})
     )
     response = UploadUtils.make_call(url, 'get')
     handle = response.body['url'].split('/').last
-    Filelink.new(handle, apikey: @apikey, security: @security)
+    FilestackFilelink.new(handle, apikey: @apikey, security: @security)
   end
 
   # Override default method (best practice when overriding method_missing)

data/lib/filestack/ruby/version.rb

@@ -1,5 +1,5 @@
 module Filestack
   module Ruby
-    VERSION = '2.0.1'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

data/lib/filestack/utils/utils.rb

@@ -63,11 +63,11 @@ module UploadUtils
     raise response.body
   end
 
-  # Generates the URL for a Filelink object
+  # Generates the URL for a FilestackFilelink object
   # @param [String]           base          The base Filestack URL
-  # @param [String]           handle        The Filelink handle (optional)
+  # @param [String]           handle        The FilestackFilelink handle (optional)
   # @param [String]           path          The specific API path (optional)
-  # @param [String]           security      Security for the Filelink (optional)
+  # @param [String]           security      Security for the FilestackFilelink (optional)
   #
   # return [String]
   def get_url(base, handle: nil, path: nil, security: nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filestack
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Filestack
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,6 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    filestack (2.0.1)
-      mimemagic (~> 0.3.2)
-      parallel (~> 1.11.2)
-      unirest (~> 1.1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.8)
-    coveralls (0.8.21)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
-      tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    json (1.8.6)
-    mime-types (1.25.1)
-    mimemagic (0.3.2)
-    parallel (1.11.2)
-    rake (12.0.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)
-    term-ansicolor (1.6.0)
-      tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.15.0)
-    unirest (1.1.2)
-      addressable (~> 2.3.5)
-      json (~> 1.8.1)
-      rest-client (~> 1.6.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.15)
-  coveralls
-  filestack!
-  rake
-  rspec (~> 3.0)
-  simplecov (~> 0.14)
-
-BUNDLED WITH
-   1.15.1