brick_ftp 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 122484c6dd656f5d580855672b0625d7c4929f5e
-  data.tar.gz: 39dc3bba8c74d45d6903ee6f69716035061e41d5
+  metadata.gz: b1573831595893f675536b07ea2a3abca125de11
+  data.tar.gz: '0148c2307700f7bee1ec25fc54f0e9f44f294f75'
 SHA512:
-  metadata.gz: a653241c38bc91b6f215b3ed88e927cffc00a347cf24c044b5ebaedc5e35a4558d499915d45f9c73059050eae2fe903079999e00287e3a7d4a8d3dbde85a60ec
-  data.tar.gz: 39b19556f6c686008fceadccf1dc4c7a40362066fb68da3615d26957d435a39cf9b158b6ba539bba14ea25f64c817b6b9f90e89d2f4a809821da183b03578eb4
+  metadata.gz: 47a7022ff8aed22042d39ccb55901dff645b822e584c9387d462651da6c36302ed79d680c7c34d62515ee9cb2d7e418165d35733021209c995a09726167982ac
+  data.tar.gz: eb55b9da62d5719cd3e0cbb96f0079e4a90171cc3659b7afc7f4dd79e20bf9cb93397446faa517d4f68244d0fb9012da35088ac3db937514349397598641c4df

data/.rubocop.yml

@@ -9,9 +9,15 @@ Style/EmptyCaseCondition:
 Style/FormatStringToken:
   EnforcedStyle: template
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 124
   AllowURI: true

data/CHANGELOG.md

@@ -2,10 +2,10 @@ Changelog
 ====
 
 
-[unreleased](https://github.com/koshigoe/brick_ftp/compare/v0.8.1...master)
+[unreleased](https://github.com/koshigoe/brick_ftp/compare/v0.8.2...master)
 ----
 
-[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.8.1...master)
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.8.2...master)
 
 ### Enhancements:
 
@@ -14,6 +14,24 @@ Changelog
 ### Breaking Changes:
 
 
+[0.8.2](https://github.com/koshigoe/brick_ftp/compare/v0.8.1...v0.8.2)
+----
+
+[Full Changelog](https://github.com/koshigoe/brick_ftp/compare/v0.8.1...v0.8.2)
+
+### Enhancements:
+
+- [#96](https://github.com/koshigoe/brick_ftp/pull/96) Add display key to history (by [terencedignon](https://github.com/terencedignon))
+
+### Fixed Bugs:
+
+### Breaking Changes:
+
+### Others
+
+- [#98](https://github.com/koshigoe/brick_ftp/pull/98) Documentation is out of date (by [terencedignon](https://github.com/terencedignon))
+
+
 [v0.8.1](https://github.com/koshigoe/brick_ftp/compare/v0.8.0...v0.8.1)
 ----
 

data/brick_ftp.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'brick_ftp/version'
 

data/lib/brick_ftp/api/base.rb

@@ -108,6 +108,12 @@ module BrickFTP
 
         read_property(method_name)
       end
+
+      def display
+        # attribute on history objects
+        # explicitly defined because display is a method on Object
+        read_property(:display)
+      end
     end
   end
 end

data/lib/brick_ftp/api/history/file.rb

@@ -16,6 +16,7 @@ module BrickFTP
         attribute :targets
         attribute :ip
         attribute :interface
+        attribute :display
       end
     end
   end

data/lib/brick_ftp/api/history/folder.rb

@@ -16,6 +16,7 @@ module BrickFTP
         attribute :targets
         attribute :ip
         attribute :interface
+        attribute :display
       end
     end
   end

data/lib/brick_ftp/api/history/login.rb

@@ -16,6 +16,7 @@ module BrickFTP
         attribute :targets
         attribute :ip
         attribute :interface
+        attribute :display
       end
     end
   end

data/lib/brick_ftp/api/history/site.rb

@@ -16,6 +16,7 @@ module BrickFTP
         attribute :targets
         attribute :ip
         attribute :interface
+        attribute :display
       end
     end
   end

data/lib/brick_ftp/api/history/user.rb

@@ -16,6 +16,7 @@ module BrickFTP
         attribute :targets
         attribute :ip
         attribute :interface
+        attribute :display
       end
     end
   end

data/lib/brick_ftp/client.rb

@@ -1,7 +1,7 @@
 module BrickFTP
   class Client
     # Login and store authentication session.
-    # @see https://brickftp.com/ja/docs/rest-api/authentication/
+    # @see https://developers.brickftp.com/#authentication-with-a-session
     # @param username [String] username of BrickFTP's user.
     # @param password [String] password of BrickFTP's user.
     def login(username, password)
@@ -9,20 +9,20 @@ module BrickFTP
     end
 
     # Logout and discard authentication session.
-    # @see https://brickftp.com/ja/docs/rest-api/authentication/
+    # @see https://developers.brickftp.com/#authentication-with-a-session
     def logout
       BrickFTP::API::Authentication.logout
     end
 
     # List all users on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#users
     # @param id user id.
     # @return [BrickFTP::API::User] user object.
     def show_user(id)
@@ -30,14 +30,14 @@ module BrickFTP
     end
 
     # Create a new user on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#users
     # @param user_or_id [BrickFTP::API::User, Integer] user object or user id.
     # @param attributes [Hash] User's attributes.
     # @return [BrickFTP::API::User] user object.
@@ -46,7 +46,7 @@ module BrickFTP
     end
 
     # Delete a user.
-    # @see https://brickftp.com/ja/docs/rest-api/users/
+    # @see https://developers.brickftp.com/#users
     # @param user_or_id [BrickFTP::API::User, Integer] user object or user id.
     # @return [Boolean] return true.
     def delete_user(user_or_id)
@@ -54,13 +54,13 @@ module BrickFTP
     end
 
     # List all groups on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @see https://developers.brickftp.com/#groups
     def list_groups
       BrickFTP::API::Group.all
     end
 
     # Show a single group.
-    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @see https://developers.brickftp.com/#groups
     # @param id group id.
     # @return [BrickFTP::API::Group] group object.
     def show_group(id)
@@ -68,14 +68,14 @@ module BrickFTP
     end
 
     # Create a new group on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#groups
     # @param group_or_id [BrickFTP::API::Group, Integer] group object or group id.
     # @param attributes [Hash] Group's attributes.
     # @return [BrickFTP::API::Group] group object.
@@ -84,7 +84,7 @@ module BrickFTP
     end
 
     # Delete a group.
-    # @see https://brickftp.com/ja/docs/rest-api/groups/
+    # @see https://developers.brickftp.com/#groups
     # @param group_or_id [BrickFTP::API::Group, Integer] group object or group id.
     # @return [Boolean] return true.
     def delete_group(group_or_id)
@@ -92,20 +92,20 @@ module BrickFTP
     end
 
     # List all permissions on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/permissions/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#permissions
     # @param permission_or_id [BrickFTP::API::Permission, Integer] permission object or permission id.
     # @return [Boolean] return true.
     def delete_permission(permission_or_id)
@@ -113,20 +113,20 @@ module BrickFTP
     end
 
     # List all notifications on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/notifications/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#notifications
     # @param notification_or_id [BrickFTP::API::Notification, Integer] notification object or notification id.
     # @return [Boolean] return true.
     def delete_notification(notification_or_id)
@@ -134,77 +134,83 @@ module BrickFTP
     end
 
     # Show the entire history for the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/history/
+    # @see https://developers.brickftp.com/#history
     # @param page [Integer] Page number of items to return in this request.
+    # @param display [String] Pass in 'full' to receive display summary
     # @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? }
+    def list_site_history(page: nil, display: nil, per_page: nil, start_at: nil)
+      query = { page: page, display: display, 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/
+    # @see https://developers.brickftp.com/#history
     # @param page [Integer] Page number of items to return in this request.
+    # @param display [String] Pass in 'full' to receive display summary
     # @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? }
+    def list_login_history(page: nil, display: nil, per_page: nil, start_at: nil)
+      query = { page: page, display: display, 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/
+    # @see https://developers.brickftp.com/#history
     # @param user_id [Integer] User ID.
+    # @param display [String] Pass in 'full' to receive display summary
     # @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(user_id:, page: nil, per_page: nil, start_at: nil)
-      query = { user_id: user_id, page: page, per_page: per_page, start_at: start_at }.reject { |_, v| v.nil? }
+    def list_user_history(user_id:, display: nil, page: nil, per_page: nil, start_at: nil)
+      query = { user_id: user_id, display: display, 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/
+    # @see https://developers.brickftp.com/#history
     # @param path [String] path of folder.
+    # @param display [String] Pass in 'full' to receive display summary
     # @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? }
+    def list_folder_history(path:, display: nil, page: nil, per_page: nil, start_at: nil)
+      query = { path: path, display: display, 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/
+    # @see https://developers.brickftp.com/#history
     # @param path [String] path of file.
+    # @param display [String] Pass in 'full' to receive display summary
     # @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? }
+    def list_file_history(path:, display: nil, page: nil, per_page: nil, start_at: nil)
+      query = { path: path, display: display, 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/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#bundles
     # @param id bundle id.
     # @return [BrickFTP::API::Bundle] bundle object.
     def show_bundle(id)
@@ -212,14 +218,14 @@ module BrickFTP
     end
 
     # Create a new bundle on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#bundles
     # @param bundle_or_id [BrickFTP::API::Bundle, Integer] bundle object or bundle id.
     # @return [Boolean] return true.
     def delete_bundle(bundle_or_id)
@@ -227,7 +233,7 @@ module BrickFTP
     end
 
     # List the contents of a bundle.
-    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @see https://developers.brickftp.com/#bundles
     # @param path [String]
     # @param code [String]
     # @param host [String]
@@ -237,7 +243,7 @@ module BrickFTP
     end
 
     # Provides download URLs that will enable you to download the files in a bundle.
-    # @see https://brickftp.com/ja/docs/rest-api/bundles/
+    # @see https://developers.brickftp.com/#bundles
     # @param code [String]
     # @param host [String]
     # @param paths [Array] array of path string.
@@ -247,14 +253,14 @@ module BrickFTP
     end
 
     # List all behaviors on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#behaviors
     # @param id behavior id.
     # @return [BrickFTP::API::Behavior] behavior object.
     def show_behavior(id)
@@ -262,14 +268,14 @@ module BrickFTP
     end
 
     # Create a new behavior on the current site.
-    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @see https://developers.brickftp.com/#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/
+    # @see https://developers.brickftp.com/#behaviors
     # @param behavior_or_id [BrickFTP::API::Behavior, Integer] behavior object or behavior id.
     # @param attributes [Hash] Behavior's attributes.
     # @return [BrickFTP::API::Behavior] behavior object.
@@ -278,7 +284,7 @@ module BrickFTP
     end
 
     # Delete a behavior.
-    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @see https://developers.brickftp.com/#behaviors
     # @param behavior_or_id [BrickFTP::API::Behavior, Integer] behavior object or behavior id.
     # @return [Boolean] return true.
     def delete_behavior(behavior_or_id)
@@ -286,14 +292,14 @@ module BrickFTP
     end
 
     # shows the behaviors that apply to the given path.
-    # @see https://brickftp.com/ja/docs/rest-api/behaviors/
+    # @see https://developers.brickftp.com/#behaviors
     # @return [Array] array of BrickFTP::API::FolderBehavior
     def list_folder_behaviors(path:)
       BrickFTP::API::FolderBehavior.all(path: path)
     end
 
     # Lists the contents of the folder provided in the URL.
-    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @see https://developers.brickftp.com/#file-and-folder-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.
@@ -315,7 +321,7 @@ module BrickFTP
     end
 
     # Create a folder.
-    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @see https://developers.brickftp.com/#file-and-folder-operations
     # @param path [String]
     # @return [BrickFTP::API::Folder]
     def create_folder(path:)
@@ -323,7 +329,7 @@ module BrickFTP
     end
 
     # provides a download URL that will enable you to download a file.
-    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @see https://developers.brickftp.com/#file-and-folder-operations
     # @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.
@@ -334,7 +340,7 @@ module BrickFTP
     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/
+    # @see https://developers.brickftp.com/#file-and-folder-operations
     # @param path [String]
     # @param move_destination [String]
     # @return [BrickFTP::API::FileMove]
@@ -343,7 +349,7 @@ module BrickFTP
     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/
+    # @see https://developers.brickftp.com/#file-and-folder-operations
     # @param path [String]
     # @param copy_destination [String]
     # @return [BrickFTP::API::FileCopy]
@@ -352,7 +358,7 @@ module BrickFTP
     end
 
     # Delete a file.
-    # @see https://brickftp.com/ja/docs/rest-api/file-operations/
+    # @see https://developers.brickftp.com/#file-and-folder-operations
     # @param file_or_path [BrickFTP::API::File, String] file object or file(folder) path.
     # @param recursive [Boolean]
     # @return [Boolean] return true.
@@ -361,7 +367,7 @@ module BrickFTP
     end
 
     # Upload file.
-    # @see https://brickftp.com/ja/docs/rest-api/file-uploading/
+    # @see https://developers.brickftp.com/#file-uploading
     # @param path [String]
     # @param source [IO] source `data` (not `path`) to upload
     # @param chunk_size [Integer] Size of chunk to multi-part upload.

data/lib/brick_ftp/version.rb

@@ -1,3 +1,3 @@
 module BrickFTP
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.8.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - koshigoe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2018-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler