brick_ftp 2.0.2 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2493a4c45ab215a268d388cb4b90802b854dac43502ed0b354bcf63bbf4e1741
-  data.tar.gz: 634f7dde30378cf62549413e408531ed9a1a100bbc91513f7895567bea8955ec
+  metadata.gz: 66d70eda3f474960acb06afe4eec881b8ea17e907f08e94e4ad9241769538c82
+  data.tar.gz: '0078a0cf19d2dde84398abe6e66c05f17dbeb45e286a4de6f0f49ad2d335fc89'
 SHA512:
-  metadata.gz: 333fa26348ec6154b7820cc2a75eb17a08de0b3d62625a028b9040401761e2545b317f34e64b8a5ed5b327ef5a918eedd32b2f23c7787a0e9f6c29f39efdb0d0
-  data.tar.gz: 39fec430bfab410417b928663bc9ebd226f981377b4680c2b5008c7b7c42660f3769d20563fc4b6abf5ce40869398da9ca78b2ae78f3a8c467ef5dce361be562
+  metadata.gz: ff38039f4ced2dbe80ef759e6b0455bc0a0edf1921a35c4a26c9df8a6128c5ef0f7c48f81ee3b976ce169162de78f1d29049948dc736c0539f8ad31e012e3c71
+  data.tar.gz: 720a8d65122b6c096317bc5e2008e8301471acca1d1a5ef715361dac65568ee11b6e10f8b81f660be29d1e1a0ffeab856a5650dddc72fe59e52dfb55234f6587

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build: &build
     docker:
-      - image: circleci/ruby:latest
+      - image: cimg/ruby:latest
     working_directory: /home/circleci/app
     steps:
       - checkout
@@ -18,33 +18,23 @@ jobs:
       - run:
           name: RSpec
           command: rspec
-  ruby-2.3:
-    <<: *build
-    docker:
-      - image: circleci/ruby:2.3
-  ruby-2.4:
-    <<: *build
-    docker:
-      - image: circleci/ruby:2.4
-  ruby-2.5:
-    <<: *build
-    docker:
-      - image: circleci/ruby:2.5
   ruby-2.6:
     <<: *build
     docker:
-      - image: circleci/ruby:2.6
+      - image: cimg/ruby:2.6
   ruby-2.7:
     <<: *build
     docker:
-      - image: circleci/ruby:2.7
+      - image: cimg/ruby:2.7
+  ruby-3.0:
+    <<: *build
+    docker:
+      - image: cimg/ruby:3.0
 
 workflows:
   version: 2
   build-using-multi-rubies:
     jobs:
-      - ruby-2.3
-      - ruby-2.4
-      - ruby-2.5
       - ruby-2.6
       - ruby-2.7
+      - ruby-3.0

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 
 Style/EmptyCaseCondition:
   Enabled: false

data/.rubocop_todo.yml

@@ -40,3 +40,10 @@ Style/Documentation:
 
 Style/Lambda:
   EnforcedStyle: literal
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Style/StringConcatenation:
+  Exclude:
+    - "spec/**/*_spec.rb"

data/CHANGELOG.md

@@ -18,6 +18,74 @@ Files::User.new(params, api_key: 'YOUR_API_KEY')
 I will archive this repository after found official SDK.
 
 
+[v2.1.2](https://github.com/koshigoe/brick_ftp/compare/v2.1.1...v2.1.2)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v2.1.1...v2.1.2)
+
+### Enhancements:
+
+- use `ruby2_keywords` to support Ruby 3.0.
+
+### Fixed Bugs:
+
+### Deprecate
+
+### Breaking Changes:
+
+- Dropping support for Ruby 2.5
+
+
+[v2.1.1](https://github.com/koshigoe/brick_ftp/compare/v2.1.0...v2.1.1)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v2.1.0...v2.1.1)
+
+### Enhancements:
+
+- [#136](https://github.com/koshigoe/brick_ftp/pull/136) Use `PATCH` instead of `PUT` to update User.
+    - see https://developers.files.com/#update-user
+
+### Fixed Bugs:
+
+### Deprecate
+
+### Breaking Changes:
+
+
+[v2.1.0](https://github.com/koshigoe/brick_ftp/compare/v2.0.3...v2.1.0)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v2.0.3...v2.1.0)
+
+### Enhancements:
+
+### Fixed Bugs:
+
+### Deprecate
+
+- Deprecate keyword argument `subdomain:` of `BrickFTP::Client#initialize`
+   - To enable to specify base URL of REST API (e.g. `http://127.0.0.1:40410/`)
+
+### Breaking Changes:
+
+- Dropping support for Ruby 2.3, 2.4
+
+
+[v2.0.3](https://github.com/koshigoe/brick_ftp/compare/v2.0.2...v2.0.3)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v2.0.2...v2.0.3)
+
+### Enhancements:
+
+### Fixed Bugs:
+
+- [#133](https://github.com/koshigoe/brick_ftp/pull/133) Fix to enable to delete folders recursively
+
+### Breaking Changes:
+
+
 [v2.0.2](https://github.com/koshigoe/brick_ftp/compare/v2.0.1...v2.0.2)
 ----
 

data/README.md

@@ -33,22 +33,18 @@ Usage
 ----
 
 ```
+$ docker compose up -d
 $ bin/console
-> client = BrickFTP::Client.new
+> client = BrickFTP::Client.new(base_url: 'http://localhost:40410', api_key: 'dummy')
 > client.list_users
 ```
 
-```
-$ bin/console
-> api_client = BrickFTP::RESTfulAPI::Client.new(ENV['BRICK_FTP_SUBDOMAIN'], ENV['BRICK_FTP_API_KEY'])
-> BrickFTP::RESTfulAPI::ListUsers.new(api_client).call
-```
-
 ### Environment Variables
 
 Name                  | Description
 --------------------- | -----------
-`BRICK_FTP_SUBDOMAIN` | Default subdomain
+`BRICK_FTP_SUBDOMAIN` | Default subdomain (deprecated)
+`BRICK_FTP_BASE_URL`  | Base URL of Files.com's REST API (e.g. `https://{subdomain}.files.com/`)
 `BRICK_FTP_API_KEY`   | Default API key
 
 

data/brick_ftp.gemspec

@@ -20,14 +20,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.add_runtime_dependency 'ruby2_keywords'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'redcarpet', '~> 3.4'
   spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.57.0'
+  spec.add_development_dependency 'rubocop', '~> 1.23'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'webmock', '~> 3.4'
   spec.add_development_dependency 'yard', '~> 0.9'

data/docker-compose.yml

@@ -0,0 +1,7 @@
+version: '3'
+
+services:
+  files-mock-server:
+    image: filescom/files-mock-server:latest
+    ports:
+      - 40410:4041

data/lib/brick_ftp/client.rb

@@ -10,14 +10,26 @@ module BrickFTP
   #   BrickFTP::Client.new.list_users
   #
   class Client
-    attr_reader :subdomain, :api_key, :api_client
+    attr_reader :base_url, :api_key, :api_client
 
-    # @param [String] subdomain
+    # @param [String] base_url
+    # @param [String] subdomain (deprecated)
     # @param [String] api_key
-    def initialize(subdomain: nil, api_key: nil)
+    def initialize(base_url: nil, subdomain: nil, api_key: nil)
+      if subdomain
+        warn('DEPRECATION WARNING: The argument `subdomain:` will be deprecated in a future version.' \
+             ' Please use `base_url:` instead.')
+      end
+
       @subdomain = subdomain || ENV['BRICK_FTP_SUBDOMAIN']
+      @base_url = base_url || ENV['BRICK_FTP_BASE_URL']
       @api_key = api_key || ENV['BRICK_FTP_API_KEY']
-      @api_client = BrickFTP::RESTfulAPI::Client.new(@subdomain, @api_key)
+      @api_client = BrickFTP::RESTfulAPI::Client.new(@base_url || @subdomain, @api_key)
+    end
+
+    def subdomain
+      warn("DEPRECATION WARNING: #{self.class.name}##{__method__} will be deprecated in a future version.")
+      @subdomain
     end
 
     private
@@ -34,6 +46,7 @@ module BrickFTP
 
     def respond_to_missing?(symbol, include_private)
       return true if command_class(symbol)
+
       super
     end
 
@@ -45,9 +58,11 @@ module BrickFTP
         super
       end
     end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
     def dispatch_command(klass, *args)
       klass.new(api_client).call(*args)
     end
+    ruby2_keywords :dispatch_command if respond_to?(:ruby2_keywords, true)
   end
 end

data/lib/brick_ftp/core_ext/hash/symbolize_keys.rb

@@ -7,10 +7,10 @@ module BrickFTP
         def symbolize_keys
           each_key.each_with_object({}) do |key, mem|
             symbolized_key = begin
-                               key.to_sym
-                             rescue StandardError
-                               key
-                             end
+              key.to_sym
+            rescue StandardError
+              key
+            end
             mem[symbolized_key] = self[key]
           end
         end

data/lib/brick_ftp/restful_api/client.rb

@@ -35,12 +35,13 @@ module BrickFTP
 
       # Initialize REST API client.
       #
-      # @param [String] subdomain
+      # @param [String] base_url
       # @param [String] api_key
       #
-      def initialize(subdomain, api_key)
-        @http = Net::HTTP.new("#{subdomain}.files.com", 443)
-        @http.use_ssl = true
+      def initialize(base_url, api_key)
+        @base_uri = make_base_uri(base_url)
+        @http = Net::HTTP.new(@base_uri.host, @base_uri.port)
+        @http.use_ssl = (@base_uri.scheme == 'https')
         @http.open_timeout = OPEN_TIMEOUT
         @http.read_timeout = READ_TIMEOUT
         @request_headers = {
@@ -146,11 +147,22 @@ module BrickFTP
         res = http.start { |session| session.request(req) }
 
         return io.size if res.is_a?(Net::HTTPSuccess)
+
         raise Error, parse_error_response(res)
       end
 
       private
 
+      DEFAULT_BASE_URL_TEMPLATE = 'https://%{subdomain}.files.com'
+
+      def make_base_uri(url_or_subdomain)
+        unless /[.:]/.match?(url_or_subdomain)
+          url_or_subdomain = format(DEFAULT_BASE_URL_TEMPLATE, subdomain: url_or_subdomain)
+        end
+
+        URI.parse(url_or_subdomain)
+      end
+
       def handle_response(response)
         case response
         when Net::HTTPNoContent
@@ -169,10 +181,10 @@ module BrickFTP
 
       def parse_error_response(response)
         parsed = begin
-                   JSON.parse(response.body)
-                 rescue StandardError
-                   {}
-                 end
+          JSON.parse(response.body)
+        rescue StandardError
+          {}
+        end
         parsed = {} unless parsed.is_a?(Hash)
 
         ErrorResponse.new(parsed.symbolize_keys).tap do |e|

data/lib/brick_ftp/restful_api/delete_folder.rb

@@ -6,25 +6,23 @@ module BrickFTP
   module RESTfulAPI
     # Delete a file or folder
     #
-    # @see https://developers.files.com/#delete-a-file-or-folder Delete a file or folder
+    # @see https://developers.files.com/#delete-file-folder Delete file/folder
     #
     class DeleteFolder
       include Command
 
       # Deletes a file or folder.
       #
-      # Note that this operation works for both files and folders, but normally it will only work on empty folders.
-      # If you want to recursively delete a folder and all its contents, send the request with a `Depth` header
-      # with the value set to `infinity`.
+      # > If true, will recursively delete folers. Otherwise, will error on non-empty folders.
       #
       # @param [String] path Full path of the file or folder. Maximum of 550 characters.
       # @param [Boolean] recursive
       #
       def call(path, recursive: false)
-        headers = {}
-        headers = { 'Depth' => 'infinity' } if recursive
+        url = "/api/rest/v1/files/#{ERB::Util.url_encode(path)}"
+        url += '?recursive=true' if recursive
 
-        client.delete("/api/rest/v1/files/#{ERB::Util.url_encode(path)}", headers)
+        client.delete(url)
         true
       end
     end

data/lib/brick_ftp/restful_api/update_user.rb

@@ -92,7 +92,7 @@ module BrickFTP
       # @return [BrickFTP::Types::User] updated User
       #
       def call(id, params)
-        res = client.put("/api/rest/v1/users/#{id}.json", params.to_h.compact)
+        res = client.patch("/api/rest/v1/users/#{id}.json", params.to_h.compact)
 
         BrickFTP::Types::User.new(**res.symbolize_keys)
       end

data/lib/brick_ftp/restful_api/upload_file.rb

@@ -17,7 +17,7 @@ module BrickFTP
     class UploadFile
       include Command
 
-      CHUNK_SIZE_RANGE = 5_242_880..5_368_709_120
+      CHUNK_SIZE_RANGE = (5_242_880..5_368_709_120).freeze
 
       # At this point, you are to send a PUT request to the returned upload_uri with the file data,
       # along with the headers and parameters provided to you from BrickFTP.

data/lib/brick_ftp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrickFTP
-  VERSION = '2.0.2'
+  VERSION = '2.1.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.2
 platform: ruby
 authors:
 - koshigoe
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,7 @@ files:
 - bin/console
 - bin/setup
 - brick_ftp.gemspec
+- docker-compose.yml
 - lib/brick_ftp.rb
 - lib/brick_ftp/client.rb
 - lib/brick_ftp/core_ext.rb
@@ -264,7 +279,7 @@ homepage: https://github.com/koshigoe/brick_ftp
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -272,15 +287,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: BrickFTP's REST API client.
 test_files: []