brick_ftp 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c48f0dbe9dcae8e1a850c64f07214a6537ee18
-  data.tar.gz: 296971fe21f4e09eec0991ed0ad623fa3dba7570
+  metadata.gz: 5b78f7e304c91c69572da2f15f66b53240beb5b5
+  data.tar.gz: dd5b06efbee8b4f23f91f33de2c36350cbb50d31
 SHA512:
-  metadata.gz: d51a198f2a54dd57fa7deea8f6ede25e9f3583a879cb85120cff35e558e771f37971fa802243d22696120a0030bf655a7505c3bfae13ae50220dc329ed0c2950
-  data.tar.gz: 4cd55009c9dc5b90c777f7f94391de5eddd554f335f73d43d937db37715f9115f3b8cba9c7e63b6ca5f110247ab12b5a403a69b0152c021255bb45fce84b6827
+  metadata.gz: 7f0b2464782ee7d0bb7660d3da573abfd302818492aa8f6675df312c70e9c0940c36524e0db692c1806686864ed12a565e8e9e0407a199d95bd0f5f779579f9f
+  data.tar.gz: d43aa3d504faf23f03b7d73f43e2f58593c68c04228cc4790fe96b6fadc311415d92cf16ba4fc6158fbaa441aa61304a642d78988d1110e689f349d5f1b17bae

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+Changelog
+====
+
+
+[unreleased](https://github.com/koshigoe/brick_ftp/compare/v0.4.0...master)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.4.0...master)
+
+### Enhancements:
+
+### Fixed Bugs:
+
+
+[0.4.0](https://github.com/koshigoe/brick_ftp/compare/v0.3.8...v0.4.0)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.3.8...v0.4.0)
+
+### Enhancements:
+
+- [#36](https://github.com/koshigoe/brick_ftp/pull/36) Add Changelog.
+- [#46](https://github.com/koshigoe/brick_ftp/pull/46) Add CLI.
+- [#53](https://github.com/koshigoe/brick_ftp/pull/53) Allow to pass `action=stat` to Files: Download API.
+
+### Fixed Bugs:

data/README.md

@@ -49,6 +49,26 @@ BrickFTP::API::Authentication.login('koshigoe', 'password')
 
 see [API document](http://www.rubydoc.info/github/koshigoe/brick_ftp/master) or source code.
 
+### CLI (experimental)
+
+#### Configuration
+
+```
+$ brick_ftp config set subdomain mydomain
+$ brick_ftp config set api_key XXXXXXXXXX
+```
+
+#### e.g. Get site usage (disk usage)
+
+```
+$ brick_ftp site usage
+```
+
+### More
+
+Please read help by run `brick_ftp help`, or read source code.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/brick_ftp.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
 
   spec.add_dependency 'deep_hash_transform', '~> 1.0'
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'inifile', '~> 3.0.0'
 end

data/exe/brick_ftp

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+root = File.dirname(File.dirname(__FILE__))
+$:.unshift(File.join(root, 'lib'))
+
+require 'brick_ftp'
+
+BrickFTP::CLI.start(ARGV)

data/lib/brick_ftp.rb

@@ -1,4 +1,5 @@
 require 'deep_hash_transform'
+require 'thor'
 require "brick_ftp/version"
 require 'brick_ftp/configuration'
 require 'brick_ftp/log_formatter'
@@ -35,6 +36,10 @@ require 'brick_ftp/api/file_operation/upload'
 require 'brick_ftp/api/site_usage'
 require 'brick_ftp/webhook'
 require 'brick_ftp/webhook/request'
+require 'brick_ftp/cli'
+require 'brick_ftp/cli/config'
+require 'brick_ftp/cli/site'
+require 'brick_ftp/cli/main'
 
 module BrickFTP
   # https://brickftp.com/redundancy/

data/lib/brick_ftp/api/base.rb

@@ -18,10 +18,11 @@ module BrickFTP
         data.map { |x| new(x.symbolize_keys) }
       end
 
-      def self.find(id)
+      def self.find(id, params: {})
         data = BrickFTP::HTTPClient.new.send(
           endpoints[:show][:http_method],
-          api_path_for(:show, id)
+          api_path_for(:show, id),
+          params: params
         )
         data.empty? ? nil : new(data.symbolize_keys)
       end
@@ -66,6 +67,14 @@ module BrickFTP
         )
         true
       end
+
+      def as_json
+        self.class.attributes.each_with_object({}) { |name, res| res[name] = send(name) }
+      end
+
+      def to_json
+        as_json.to_json
+      end
     end
   end
 end

data/lib/brick_ftp/cli.rb

@@ -0,0 +1,7 @@
+module BrickFTP
+  module CLI
+    def self.start(argv)
+      Main.start(argv)
+    end
+  end
+end

data/lib/brick_ftp/cli/config.rb

@@ -0,0 +1,20 @@
+module BrickFTP
+  module CLI
+    class Config < Thor
+      desc 'get NAME', 'Show specified configuration.'
+      def get(name)
+        abort 'No such configuration.' unless BrickFTP.config.respond_to?(name)
+
+        puts BrickFTP.config.send(name)
+      end
+
+      desc 'set NAME VALUE', 'Set configuration value.'
+      def set(name, value)
+        abort 'No such configuration.' unless BrickFTP.config.respond_to?("#{name}=")
+
+        BrickFTP.config.send("#{name}=", value)
+        BrickFTP.config.save!
+      end
+    end
+  end
+end

data/lib/brick_ftp/cli/main.rb

@@ -0,0 +1,26 @@
+module BrickFTP
+  module CLI
+    class Main < Thor
+      class_option :profile,
+                   desc: 'Configuration profile.',
+                   default: 'global',
+                   type: :string
+
+      class_option :config,
+                   desc: 'Path for configuration file.',
+                   default: BrickFTP::Configuration::CONFIG_FILE_PATH,
+                   type: :string
+
+      def initialize(*args)
+        super
+        BrickFTP.config = BrickFTP::Configuration.new(profile: options[:profile], config_file_path: options[:config])
+      end
+
+      desc 'config COMMAND', 'Manage configuration.'
+      subcommand 'config', BrickFTP::CLI::Config
+
+      desc 'site COMMAND', 'Manage site.'
+      subcommand 'site', BrickFTP::CLI::Site
+    end
+  end
+end

data/lib/brick_ftp/cli/site.rb

@@ -0,0 +1,10 @@
+module BrickFTP
+  module CLI
+    class Site < Thor
+      desc 'usage', 'Show site usage.'
+      def usage
+        puts BrickFTP::API::SiteUsage.find.to_json
+      end
+    end
+  end
+end

data/lib/brick_ftp/client.rb

@@ -315,10 +315,13 @@ module BrickFTP
 
     # provides a download URL that will enable you to download a file.
     # @see https://brickftp.com/ja/docs/rest-api/file-operations/
-    # @param id file id.
+    # @param path [String] path for file.
+    # @param omit_download_uri [Boolean] If true, omit download_uri. (Add query `action=stat`)
     # @return [BrickFTP::API::File] file object.
-    def show_file(id)
-      BrickFTP::API::File.find(id)
+    def show_file(path, omit_download_uri: false)
+      params = {}
+      params[:action] = 'stat' if omit_download_uri
+      BrickFTP::API::File.find(path, params: params)
     end
 
     # Move or renames a file or folder to the destination provided in the move_destination parameter.

data/lib/brick_ftp/configuration.rb

@@ -1,7 +1,14 @@
 require 'logger'
+require 'inifile'
 
 module BrickFTP
   class Configuration
+    # Name of configuration profile.
+    # @return [String] profile
+    attr_reader :profile
+    # Path for configuration file.
+    # @return [String] path
+    attr_reader :config_file_path
     # Subdomain of API endpoint. If not specified, get value from enviroment variable `BRICK_FTP_SUBDOMAIN`.
     # @return [String] subdomain
     attr_accessor :subdomain
@@ -16,10 +23,10 @@ module BrickFTP
     attr_accessor :logger
     # Log level
     # @return [Integer]
-    attr_reader :log_level
+    attr_accessor :log_level
     # Log formatter
     # @return [Logger::Formatter]
-    attr_reader :log_formatter
+    attr_accessor :log_formatter
     # Open timeout
     # @return [Integer]
     attr_accessor :open_timeout
@@ -30,16 +37,34 @@ module BrickFTP
     DEFAULT_OPEN_TIMEOUT = 10
     DEFAULT_READ_TIMEOUT = 30
 
-    def initialize
-      self.subdomain = ENV['BRICK_FTP_SUBDOMAIN']
-      self.api_key = ENV['BRICK_FTP_API_KEY']
+    DEFAULT_PROFILE = 'global'.freeze
+    CONFIG_FILE_PATH = File.expand_path('~/.brick_ftp/config').freeze
+    # Name of storable configurations. (TODO: log_path, log_level, log_formatter)
+    STORABLE_CONFIGURATION_KEYS = %w(subdomain api_key open_timeout read_timeout).freeze
+
+    STORABLE_CONFIGURATION_KEYS.each do |name|
+      define_method("#{name}=") do |value|
+        dirty_attributes.add(name)
+        instance_variable_set(:"@#{name}", value)
+      end
+    end
+
+    def initialize(profile: DEFAULT_PROFILE, config_file_path: CONFIG_FILE_PATH)
+      @profile = profile
+      @config_file_path = config_file_path
+      load_config_file(config_file_path)
+
+      self.subdomain = ENV.fetch('BRICK_FTP_SUBDOMAIN', inifile[profile]['subdomain'])
+      self.api_key = ENV.fetch('BRICK_FTP_API_KEY', inifile[profile]['api_key'])
       self.session = nil
-      self.open_timeout = DEFAULT_OPEN_TIMEOUT
-      self.read_timeout = DEFAULT_READ_TIMEOUT
+      self.open_timeout = (inifile[profile]['open_timeout'] || DEFAULT_OPEN_TIMEOUT).to_i
+      self.read_timeout = (inifile[profile]['read_timeout'] || DEFAULT_READ_TIMEOUT).to_i
       self.logger = Logger.new(STDOUT)
       self.log_level = Logger::WARN
       self.log_formatter = Logger::Formatter.new
       logger.level = log_level
+
+      dirty_attributes.clear
     end
 
     # Host name of API endpoint.
@@ -61,5 +86,29 @@ module BrickFTP
       @log_formatter = formatter
       logger.formatter = @log_formatter
     end
+
+    def save!
+      dirty_attributes.each do |key|
+        inifile[profile][key] = send(key)
+      end
+      FileUtils.mkdir_p(File.dirname(inifile.filename)) unless File.exist?(File.dirname(inifile.filename))
+      inifile.save
+    end
+
+    private
+
+    attr_reader :inifile, :dirty_attributes
+
+    def load_config_file(config_file_path)
+      @inifile = if File.exist?(config_file_path)
+                   IniFile.load(config_file_path, encoding: 'UTF-8')
+                 else
+                   IniFile.new(filename: config_file_path, encoding: 'UTF-8')
+                 end
+    end
+
+    def dirty_attributes
+      @dirty_attributes ||= Set.new
+    end
   end
 end

data/lib/brick_ftp/http_client.rb

@@ -1,5 +1,6 @@
 require 'net/https'
 require 'json'
+require 'cgi'
 
 module BrickFTP
   class HTTPClient
@@ -35,7 +36,10 @@ module BrickFTP
     end
 
     def get(path, params: {}, headers: {})
-      case res = request(:get, path, params: params, headers: headers)
+      query = params.map { |k, v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join('&')
+      path = "#{path}?#{query}" unless query.empty?
+
+      case res = request(:get, path, headers: headers)
       when Net::HTTPSuccess
         res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
       else

data/lib/brick_ftp/version.rb

@@ -1,3 +1,3 @@
 module BrickFTP
-  VERSION = "0.3.8"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - koshigoe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,16 +108,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: BrickFTP's REST API client.
 email:
 - koshigoeb@gmail.com
-executables: []
+executables:
+- brick_ftp
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -125,6 +155,7 @@ files:
 - bin/console
 - bin/setup
 - brick_ftp.gemspec
+- exe/brick_ftp
 - lib/brick_ftp.rb
 - lib/brick_ftp/api.rb
 - lib/brick_ftp/api/authentication.rb
@@ -155,6 +186,10 @@ files:
 - lib/brick_ftp/api/user.rb
 - lib/brick_ftp/api_component.rb
 - lib/brick_ftp/api_definition.rb
+- lib/brick_ftp/cli.rb
+- lib/brick_ftp/cli/config.rb
+- lib/brick_ftp/cli/main.rb
+- lib/brick_ftp/cli/site.rb
 - lib/brick_ftp/client.rb
 - lib/brick_ftp/configuration.rb
 - lib/brick_ftp/http_client.rb