brick_ftp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 763c13ebed0e36da20c18284f3a679314c991d6b
-  data.tar.gz: d04fbfdbfd3c579010d5880d0e755a0b65f156e7
+  metadata.gz: 0b3bf69a33bce75c836d9f0a892647127e9a52d8
+  data.tar.gz: ac40a241fa853a76d0b156de3d7a5946c00f037d
 SHA512:
-  metadata.gz: 35aabedc78ef3f7c9af8574551705321be517eedd940b0b52a1dd3f59aedd9fca38893303d344167e5559f8bed684e31c7e09794d7a215368741dd19cc68bfe9
-  data.tar.gz: de4d25dd868eb8b1f8f90238ee30fc2d66062553841f931f141d4ea0aecc767f4adb73746b5409f3dbdcba55386e4be150789761634607db86742e194b7a2009
+  metadata.gz: 39d59472f0eee719336531c6f79dad2605d426690452f01875036020c45f990e919674351b807f3794f817c023efa498c888aadac7ddd70f6357c214dcbfd209
+  data.tar.gz: 3512bd4ce61bdcfe14cfca362bbd437f02be765b07aeae1db6e7fff0d7096c0077f90838780ccb13e31f37483739071f948172e566847f936bcd59a944edf73c

data/README.md

@@ -47,7 +47,7 @@ BrickFTP::API::Authentication.login('koshigoe', 'password')
 
 ### Other APIs
 
-see API document or source code.
+see [API document](http://www.rubydoc.info/github/koshigoe/brick_ftp/master) or source code.
 
 ## Development
 
@@ -57,5 +57,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/brick_ftp.
+Bug reports and pull requests are welcome on GitHub at https://github.com/koshigoe/brick_ftp.
 

data/brick_ftp.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "yard", "~> 0.9"
 
   spec.add_dependency 'deep_hash_transform', '~> 1.0'
 end

data/lib/brick_ftp.rb

@@ -2,6 +2,7 @@ require 'deep_hash_transform'
 require "brick_ftp/version"
 require 'brick_ftp/configuration'
 require 'brick_ftp/http_client'
+require 'brick_ftp/client'
 require 'brick_ftp/api'
 require 'brick_ftp/api/base'
 require 'brick_ftp/api/authentication'
@@ -29,15 +30,33 @@ require 'brick_ftp/api/file_copy'
 require 'brick_ftp/api/file_upload'
 
 module BrickFTP
+  # Return configuration.
+  # If it has not been configured yet, initialize configuration.
+  # @return [BrickFTP::Configuration] configuration object.
   def self.config
     @config ||= BrickFTP::Configuration.new
   end
 
+  # Set configuration.
+  #
+  # @param config [BrickFTP::Configuration] configuration object.
+  # @return [BrickFTP::Configuration] configuration object.
   def self.config=(config)
     raise TypeError unless config.is_a?(BrickFTP::Configuration)
     @config = config
   end
 
+  # Configure some settings.
+  #
+  # @yield [config] Given configuration object.
+  # @yieldparam config [BrickFTP::Configuration] configuration object.
+  #
+  # @example
+  #   BrickFTP.configure do |c|
+  #     c.subdomain = 'koshigoe'
+  #     c.api_key = 'xxxxxxxxxx'
+  #   end
+  #
   def self.configure
     yield(config)
   end

data/lib/brick_ftp/api/authentication.rb

@@ -5,14 +5,21 @@ module BrickFTP
     module Authentication
       COOKIE_NAME = 'BrickFTP'.freeze
 
+      # Generate authentication cookie.
+      # @param session [BrickFTP::API::Authentication::Session] authentication session object.
+      # @return [CGI::Cookie] authentication cookie.
       def self.cookie(session)
         CGI::Cookie.new(COOKIE_NAME, session.id)
       end
 
+      # Alias for `BrickFTP::API::Authentication::Session.create`.
+      # @param username [String] username of BrickFTP's user.
+      # @param password [String] password of BrickFTP's user.
       def self.login(username, password)
         Session.create(username: username, password: password)
       end
 
+      # Alias for `BrickFTP::API::Authentication::Session#destroy`.
       def self.logout
         BrickFTP.config.session.destroy
       end

data/lib/brick_ftp/api/file_upload.rb

@@ -26,15 +26,15 @@ module BrickFTP
                                  :provided_mtime,
                                  :permissions
 
-      def self.create(params, path_params = {})
+      def self.create(path: , source:)
         api_client = BrickFTP::HTTPClient.new
-        step1 = api_client.post(api_path_for(:create, path_params), params: { action: 'put' })
+        step1 = api_client.post(api_path_for(:create, path: path), params: { action: 'put' })
 
         upload_uri = URI.parse(step1['upload_uri'])
         upload_client = BrickFTP::HTTPClient.new(upload_uri.host)
-        upload_client.put(step1['upload_uri'], params: params)
+        upload_client.put(step1['upload_uri'], params: source)
 
-        step3 = api_client.post(api_path_for(:create, path_params), params: { action: 'end', ref: step1['ref'] })
+        step3 = api_client.post(api_path_for(:create, path: path), params: { action: 'end', ref: step1['ref'] })
 
         new(step1.merge(step3).symbolize_keys)
       end

data/lib/brick_ftp/api/history.rb

@@ -1,5 +1,5 @@
 module BrickFTP
-  module APi
+  module API
     module History
     end
   end

data/lib/brick_ftp/client.rb

@@ -1,9 +1,358 @@
 module BrickFTP
   class Client
-    attr_reader :api_key
+    # Login and store authentication session.
+    # @see https://brickftp.com/ja/docs/rest-api/authentication/
+    # @param username [String] username of BrickFTP's user.
+    # @param password [String] password of BrickFTP's user.
+    def login(username, password)
+      BrickFTP::API::Authentication.login(username, password)
+    end
+
+    # Logout and discard authentication session.
+    # @see https://brickftp.com/ja/docs/rest-api/authentication/
+    def logout
+      BrickFTP::API::Authentication.logout
+    end
+
+    # List all users on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @return [Array] array of BrickFTP::API::User
+    def list_users
+      BrickFTP::API::User.all
+    end
+
+    # Show a single user.
+    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @param id user id.
+    # @return [BrickFTP::API::User] user object.
+    def show_user(id)
+      BrickFTP::API::User.find(id)
+    end
+
+    # Create a new user on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @param attributes [Hash] User's attributes.
+    def create_user(attributes)
+      BrickFTP::API::User.create(attributes)
+    end
+
+    # Update an existing user.
+    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @param user [BrickFTP::API::User] user object.
+    # @param attributes [Hash] User's attributes.
+    # @return [BrickFTP::API::User] user object.
+    def update_user(user, attributes)
+      user.update(attributes)
+    end
+
+    # Delete a user.
+    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @param user [BrickFTP::API::User] user object.
+    # @return [Boolean] return true.
+    def delete_user(user)
+      user.destroy
+    end
+
+    # List all groups on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    def list_groups
+      BrickFTP::API::Group.all
+    end
+
+    # Show a single group.
+    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @param id group id.
+    # @return [BrickFTP::API::Group] group object.
+    def show_group(id)
+      BrickFTP::API::Group.find(id)
+    end
+
+    # Create a new group on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @param attributes [Hash] Group's attributes.
+    def create_group(attributes)
+      BrickFTP::API::Group.create(attributes)
+    end
+
+    # Update an existing group.
+    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @param group [BrickFTP::API::Group] group object.
+    # @param attributes [Hash] Group's attributes.
+    # @return [BrickFTP::API::Group] group object.
+    def update_group(group, attributes)
+      group.update(attributes)
+    end
+
+    # Delete a group.
+    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @param group [BrickFTP::API::Group] group object.
+    # @return [Boolean] return true.
+    def delete_group(group)
+      group.destroy
+    end
+
+    # List all permissions on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/permissions/
+    def list_permissions
+      BrickFTP::API::Permission.all
+    end
+
+    # Create a new permission on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/permissions/
+    # @param attributes [Hash] Permission's attributes.
+    def create_permission(attributes)
+      BrickFTP::API::Permission.create(attributes)
+    end
+
+    # Delete a permission.
+    # @see https://brickftp.com/ja/docs/rest-api/permissions/
+    # @param permission [BrickFTP::API::Permission] permission object.
+    # @return [Boolean] return true.
+    def delete_permission(permission)
+      permission.destroy
+    end
+
+    # List all notifications on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/notifications/
+    def list_notifications
+      BrickFTP::API::Notification.all
+    end
+
+    # Create a new notification on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/notifications/
+    # @param attributes [Hash] Notification's attributes.
+    def create_notification(attributes)
+      BrickFTP::API::Notification.create(attributes)
+    end
+
+    # Delete a notification.
+    # @see https://brickftp.com/ja/docs/rest-api/notifications/
+    # @param notification [BrickFTP::API::Notification] notification object.
+    # @return [Boolean] return true.
+    def delete_notification(notification)
+      notification.destroy
+    end
+
+    # Show the entire history for the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/history/
+    # @param page [Integer] Page number of items to return in this request.
+    # @param per_page [Integer] Requested number of items returned per request. Default: 1000, maximum: 10000. Leave blank for default (strongly recommended).
+    # @param start_at [String] Date and time in the history to start from.
+    # @return [Array] array of `BrickFTP::API::History::Site`
+    def list_site_history(page: nil, per_page: nil, start_at: nil)
+      query = { page: page, per_page: per_page, start_at: start_at }.reject { |_, v| v.nil? }
+      BrickFTP::API::History::Site.all(query)
+    end
+
+    # Show login history only.
+    # @see https://brickftp.com/ja/docs/rest-api/history/
+    # @param page [Integer] Page number of items to return in this request.
+    # @param per_page [Integer] Requested number of items returned per request. Default: 1000, maximum: 10000. Leave blank for default (strongly recommended).
+    # @param start_at [String] Date and time in the history to start from.
+    # @return [Array] array of `BrickFTP::API::History::Login`
+    def list_login_history(page: nil, per_page: nil, start_at: nil)
+      query = { page: page, per_page: per_page, start_at: start_at }.reject { |_, v| v.nil? }
+      BrickFTP::API::History::Login.all(query)
+    end
+
+    # Show all history for a specific user.
+    # @see https://brickftp.com/ja/docs/rest-api/history/
+    # @param page [Integer] Page number of items to return in this request.
+    # @param per_page [Integer] Requested number of items returned per request. Default: 1000, maximum: 10000. Leave blank for default (strongly recommended).
+    # @param start_at [String] Date and time in the history to start from.
+    # @return [Array] array of `BrickFTP::API::History::User`
+    def list_user_history(page: nil, per_page: nil, start_at: nil)
+      query = { page: page, per_page: per_page, start_at: start_at }.reject { |_, v| v.nil? }
+      BrickFTP::API::History::User.all(query)
+    end
+
+    # Show all history for a specific folder.
+    # @see https://brickftp.com/ja/docs/rest-api/history/
+    # @param path [String] path of folder.
+    # @param page [Integer] Page number of items to return in this request.
+    # @param per_page [Integer] Requested number of items returned per request. Default: 1000, maximum: 10000. Leave blank for default (strongly recommended).
+    # @param start_at [String] Date and time in the history to start from.
+    # @return [Array] array of `BrickFTP::API::History::Folder`
+    def list_folder_history(path:, page: nil, per_page: nil, start_at: nil)
+      query = { path: path, page: page, per_page: per_page, start_at: start_at }.reject { |_, v| v.nil? }
+      BrickFTP::API::History::Folder.all(query)
+    end
+
+    # Show all history for a specific file.
+    # @see https://brickftp.com/ja/docs/rest-api/history/
+    # @param path [String] path of file.
+    # @param page [Integer] Page number of items to return in this request.
+    # @param per_page [Integer] Requested number of items returned per request. Default: 1000, maximum: 10000. Leave blank for default (strongly recommended).
+    # @param start_at [String] Date and time in the history to start from.
+    # @return [Array] array of `BrickFTP::API::History::File`
+    def list_file_history(path:, page: nil, per_page: nil, start_at: nil)
+      query = { path: path, page: page, per_page: per_page, start_at: start_at }.reject { |_, v| v.nil? }
+      BrickFTP::API::History::File.all(query)
+    end
+
+    # List all bundles on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @return [Array] array of BrickFTP::API::Bundle
+    def list_bundles
+      BrickFTP::API::Bundle.all
+    end
+
+    # Show a single bundle.
+    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @param id bundle id.
+    # @return [BrickFTP::API::Bundle] bundle object.
+    def show_bundle(id)
+      BrickFTP::API::Bundle.find(id)
+    end
+
+    # Create a new bundle on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @param attributes [Hash] Bundle's attributes.
+    def create_bundle(attributes)
+      BrickFTP::API::Bundle.create(attributes)
+    end
+
+    # Delete a bundle.
+    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @param bundle [BrickFTP::API::Bundle] bundle object.
+    # @return [Boolean] return true.
+    def delete_bundle(bundle)
+      bundle.destroy
+    end
+
+    # List the contents of a bundle.
+    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @param path [String]
+    # @param code [String]
+    # @param host [String]
+    # @return [Array] array of `BrickFTP::API::BundleContent`.
+    def list_bundle_contents(path: nil, code:, host:)
+      BrickFTP::API::BundleContent.all(path: path, code: code, host: host)
+    end
+
+    # Provides download URLs that will enable you to download the files in a bundle.
+    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @param code [String]
+    # @param host [String]
+    # @param paths [Array] array of path string.
+    # @return [Array] array of `BrickFTP::API::BundleDownload`.
+    def list_bundle_downloads(code:, host:, paths: [])
+      BrickFTP::API::BundleDownload.all(code: code, host: host, paths: paths)
+    end
+
+    # List all behaviors on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @return [Array] array of BrickFTP::API::Behavior
+    def list_behaviors
+      BrickFTP::API::Behavior.all
+    end
+
+    # Show a single behavior.
+    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @param id behavior id.
+    # @return [BrickFTP::API::Behavior] behavior object.
+    def show_behavior(id)
+      BrickFTP::API::Behavior.find(id)
+    end
+
+    # Create a new behavior on the current site.
+    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @param attributes [Hash] Behavior's attributes.
+    def create_behavior(attributes)
+      BrickFTP::API::Behavior.create(attributes)
+    end
+
+    # Update an existing behavior.
+    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @param behavior [BrickFTP::API::Behavior] behavior object.
+    # @param attributes [Hash] Behavior's attributes.
+    # @return [BrickFTP::API::Behavior] behavior object.
+    def update_behavior(behavior, attributes)
+      behavior.update(attributes)
+    end
+
+    # Delete a behavior.
+    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @param behavior [BrickFTP::API::Behavior] behavior object.
+    # @return [Boolean] return true.
+    def delete_behavior(behavior)
+      behavior.destroy
+    end
+
+    # shows the behaviors that apply to the given path.
+    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @return [Array] array of BrickFTP::API::BehaviorFolder
+    def list_folder_behaviors(path:)
+      BrickFTP::API::BehaviorFolder.all(path: path)
+    end
+
+    # Lists the contents of the folder provided in the URL.
+    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @param path [String]
+    # @param page [Integer] Page number of items to return in this request.
+    # @param per_page [Integer] Requested number of items returned per request. Maximum: 5000, leave blank for default (strongly recommended).
+    # @param search [String] Only return items matching the given search text.
+    # @param sort_by_path [String] Sort by file name, and value is either asc or desc to indicate normal or reverse sort. (Note that sort_by[path] = asc is the default.)
+    # @param sort_by_size [String] Sort by file size, and value is either asc or desc to indicate smaller files first or larger files first, respectively.
+    # @param sort_by_modified_at_datetime [String] Sort by modification time, and value is either asc or desc to indicate older files first or newer files first, respectively.
+    # @return [Array] array of BrickFTP::API::Folder.
+    def list_folders(path:, page: nil, per_page: nil, search: nil, sort_by_path: nil, sort_by_size: nil, sort_by_modified_at_datetime: nil)
+      query = { path: path, page: page, per_page: per_page, search: search }.reject { |_, v| v.nil? }
+      query[:'sort_by[path]'] = sort_by_path if sort_by_path
+      query[:'sort_by[size]'] = sort_by_size if sort_by_size
+      query[:'sort_by[modified_at_datetime]'] = sort_by_modified_at_datetime if sort_by_modified_at_datetime
+      BrickFTP::API::Folder.all(query)
+    end
+
+    # Create a folder.
+    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @param path [String]
+    # @return [BrickFTP::API::Folder]
+    def create_folder(path:)
+      BrickFTP::API::Folder.create(path: path)
+    end
+
+    # 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.
+    # @return [BrickFTP::API::File] file object.
+    def show_file(id)
+      BrickFTP::API::File.find(id)
+    end
+
+    # Move or renames a file or folder to the destination provided in the move_destination parameter.
+    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @param path [String]
+    # @param move_destination [String]
+    # @return [BrickFTP::API::FileMove]
+    def move_file(path:, move_destination:)
+      BrickFTP::API::FileMove.create(path: path, move_destination: move_destination)
+    end
+
+    # Copy a file or folder to the destination provided in the copy_destination parameter.
+    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @param path [String]
+    # @param copy_destination [String]
+    # @return [BrickFTP::API::FileCopy]
+    def copy_file(path:, copy_destination:)
+      BrickFTP::API::FileCopy.create(path: path, copy_destination: copy_destination)
+    end
+
+    # Delete a file.
+    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @param file [BrickFTP::API::File] file object.
+    # @return [Boolean] return true.
+    def delete_file(file)
+      file.destroy
+    end
 
-    def initialize(api_key: nil)
-      @api_key = api_key
+    # Upload file.
+    # @see https://brickftp.com/ja/docs/rest-api/file-uploading/
+    # @param path [String]
+    # @param source [String] path for source file.
+    # @return [BrickFTP::API::FileUpload]
+    def upload_file(path:, source:)
+      BrickFTP::API::FileUpload.create(path: path, source: source)
     end
   end
 end

data/lib/brick_ftp/configuration.rb

@@ -2,9 +2,17 @@ require 'logger'
 
 module BrickFTP
   class Configuration
+    # Subdomain of API endpoint. If not specified, get value from enviroment variable `BRICK_FTP_SUBDOMAIN`.
+    # @return [String] subdomain
     attr_accessor :subdomain
+    # Access key of API. If not specified, get value from enviroment variable `BRICK_FTP_API_KEY`.
+    # @return [String] API access key
     attr_accessor :api_key
+    # Authentication session for cookie auth.
+    # @return [BrickFTP::API::Authentication::Session] authentication session object.
     attr_accessor :session
+    # Logger.
+    # @return [Logger] logger
     attr_accessor :logger
 
     def initialize
@@ -16,6 +24,8 @@ module BrickFTP
       logger.level = Logger::WARN
     end
 
+    # Host name of API endpoint.
+    # @return [String] API host
     def api_host
       "#{subdomain}.brickftp.com"
     end

data/lib/brick_ftp/version.rb

@@ -1,3 +1,3 @@
 module BrickFTP
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - koshigoe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: deep_hash_transform
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: BrickFTP's REST API client.