brick_ftp 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f89f5228f66c2b5a9b36d711b39ed799d41eb2257106a3306d15f87baff57859
-  data.tar.gz: e3e76df6a6829230a55168dd76e82d659967a232d5a19f8cde26ee0686ce3607
+  metadata.gz: '0963dd222588305e1338d88de6cbbc880994cc1c6d6285d1db7611f0d211745d'
+  data.tar.gz: 9677a3209ae374ce09cc879a057b742c9cb59773417a040302658cb1a23b0e34
 SHA512:
-  metadata.gz: a796baec9ec77b321d2856b59efcd7a45ccb665ae23df4cd4d82d1814894de43d4d4502000824ddc2eae00f89440fdaad0a7d7a300e99d0fe8c4930b968a7f30
-  data.tar.gz: 1eccf58c09d2ed1dd3c96ebb3ebf3bbae8675b9d5bf076f11793e96746fa7c03fd34e5413e098007a4ec27953755b7cf06780b4d033ad5896a2914b01347df0b
+  metadata.gz: 1c29f0e5dd4a68a7252d5c5c6559056c821ba9a865efbed6fd50c406f0126106f7fc8c7dba23e0a3941d82f17df428d373e7112a3a1449b36b7f09cb1a97bbc7
+  data.tar.gz: c9652d9b29f3886cfd3b81b5b0441d661b93d178e0f823816dd409058e3082f9c5589c277a87647649b152fffbe8504f041240e0d1ec66ccd4f4c965ac0f4a02

data/.circleci/config.yml

@@ -18,14 +18,6 @@ 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:
@@ -43,8 +35,6 @@ workflows:
   version: 2
   build-using-multi-rubies:
     jobs:
-      - ruby-2.3
-      - ruby-2.4
       - ruby-2.5
       - ruby-2.6
       - ruby-2.7

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
 
 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,25 @@ Files::User.new(params, api_key: 'YOUR_API_KEY')
 I will archive this repository after found official SDK.
 
 
+[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)
 ----
 

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,7 +20,7 @@ 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.5.0'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'pry', '~> 0.11'

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
 

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/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.3'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - koshigoe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,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
@@ -272,14 +273,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: BrickFTP's REST API client.