pcloud_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc6a66525cb7bfd47085851a95dbc1656759f92960611d1d66e5f466025c800
-  data.tar.gz: 3eb54b53ab7c2c97ece4db9a074cbf75d6aa602ba727c917a6f88dbc97997c92
+  metadata.gz: 6d2d4a15b64f7b12aeb37ea79a46d0fb0a24c05237e233a3a8d58318e1cb9668
+  data.tar.gz: 8e99af1069835bf83aec4d57f4a3bc62f9a0d26378758ea3a4d22c4ceb06af9e
 SHA512:
-  metadata.gz: 0ce986fc8cdedaed9773209c26afbaf08091d4285abbb40126a0fcc0fcac99d77bd1ce1250bed6cdce4dd79e445076ca49469f6ce0c2e3ccfb597a36bf41f79f
-  data.tar.gz: 5aa4fb9d5dd96227b61c18c2bc537ad4b73338509e8a0e6b710cc06415228c41f67efb7719258ae954eb0fe9f36fae55d9151622021fb1f4d8116767aae1cad8
+  metadata.gz: c2d382dece8651dc09d5838db291ae1006dccb525c61ac41b031875ff1d5a10d14484078b0e6cb4602c31ee2c2fffcff2fb8b44846c4bd2b0b116f7b90c7d8b6
+  data.tar.gz: dfe07a834b0ca71fb469acb6b017a83352e6519db2b436aee3dd5217385ac8885fc579ef5baab0b85b9c535e3a49b211a42aff1e4114238cc9c06514f0dedde5

data/CHANGELOG.md

@@ -1,13 +1,20 @@
-## 0.2.0 2021-09-26
+## 0.2.1 2021-10-07
 
-New
-  * An `.exists?` method has been added to `Pcloud::Folder` and `Pcloud::File`
-  * The `.find_by` method on `Pcloud::Folder` and `Pcloud::File` can now be called with either `:id` or `:path`. NOTE: pCloud treats `:id` with precedence, so an error will be raised if the method is called with both parameters at once. _(Allowing precedence in a method like this would likely feel like unexpected behavior, so my intention was to make it immediately obvious to the end user.)_
+**Changes**
+  1. Simplifying and cleaning up the errors returned from `Pcloud::Folder` and `Pcloud::File`
 
-Change
- * `Pcloud::Folder` and `Pcloud::File` `created_at` and `modified_at` timestamps are now returned as Ruby `Time` objects
- * Some error class names and messages have been cleaned up for additional clarity and consistency.
+## 0.2.0 2021-10-07
+
+**New**
+  1. An `.exists?` method has been added to `Pcloud::Folder` and `Pcloud::File`
+  2. The `.find_by` method on `Pcloud::Folder` and `Pcloud::File` can now be called with either `:id` or `:path` parameters.
+     * NOTE: pCloud treats `:id` with precedence, so an error will be raised if the method is called with both parameters at once. _(Allowing precedence in a method like this would likely feel like unexpected behavior, so my intention was to make it immediately obvious to the end user.)_
+
+**Changes**
+  1. The `created_at` and `modified_at` timestamps on `Pcloud::Folder` and `Pcloud::File` are now returned as Ruby `Time` objects _(specifically [`TZInfo::TimeWithOffset`](https://www.rubydoc.info/gems/tzinfo/TZInfo/TimeWithOffset))_.
+     * NOTE: if you were previously parsing the string timestamps out into time objects, you may see errors like `no implicit conversion of TZInfo::TimeWithOffset into String`
+  2. Some error class names and messages have been cleaned up for additional clarity and consistency.
 
 ## 0.1.0 2021-09-26
 
-Initial release
+**Initial release** 🍰 🎉

data/lib/pcloud/file.rb

@@ -1,6 +1,5 @@
 module Pcloud
   class File
-    class ManformedUpdateParams < StandardError; end
     class InvalidParameter < StandardError; end
     class InvalidParameters < StandardError; end
     class MissingParameter < StandardError; end
@@ -10,6 +9,7 @@ module Pcloud
     include Pcloud::TimeHelper
 
     SUPPORTED_UPDATE_PARAMS = [:name, :parent_folder_id, :path].freeze
+    SUPPORTED_FIND_BY_PARAMS = [:id, :path].freeze
     FILE_CATAGORIES = {
       "0" => "uncategorized",
       "1" => "image",
@@ -39,8 +39,8 @@ module Pcloud
       unless (params.keys - SUPPORTED_UPDATE_PARAMS).empty?
         raise InvalidParameters.new("Must be one of #{SUPPORTED_UPDATE_PARAMS}")
       end
-      if params[:path] && is_invalid_path_param?(params[:path])
-        raise ManformedUpdateParams.new(":path param must start and end with `/`")
+      if params[:path] && is_invalid_path_update_param?(params[:path])
+        raise InvalidParameter.new(":path param must start and end with `/`")
       end
       query = {
         fileid: id,
@@ -75,8 +75,8 @@ module Pcloud
 
     private
 
-    def is_invalid_path_param?(path_param)
-      # Path params have to start and end with `/`
+    def is_invalid_path_update_param?(path_param)
+      # Path params have to start and end with `/` when used with .update
       [path_param[0], path_param[-1]] != ["/", "/"]
     end
 
@@ -94,14 +94,12 @@ module Pcloud
       end
 
       def find_by(params)
-        raise MissingParameter.new(":path or :id is required") unless params[:path] || params[:id]
+        unless (params.keys - SUPPORTED_FIND_BY_PARAMS).empty?
+          raise InvalidParameters.new("Must be one of #{SUPPORTED_FIND_BY_PARAMS}")
+        end
         raise InvalidParameters.new(":id takes precedent over :path, please only use one or the other") if params[:path] && params[:id]
-        parse_one(
-          Client.execute(
-            "stat",
-            query: { path: params[:path], fileid: params[:id] }.compact
-          )
-        )
+        query = { path: params[:path], fileid: params[:id] }.compact
+        parse_one(Client.execute("stat", query: query))
       end
 
       def upload(params)
@@ -116,7 +114,7 @@ module Pcloud
 
       def process_upload(params)
         file = params.fetch(:file)
-        raise InvalidParameter.new("The `file` parameter must be an instance of Ruby `File`") unless file.is_a?(::File)
+        raise InvalidParameter.new("The :file parameter must be an instance of Ruby `File`") unless file.is_a?(::File)
 
         # === pCloud API behavior notes: ===
         # 1. If neither `path` nor `folder_id` is provided, the file will be

data/lib/pcloud/folder.rb

@@ -1,7 +1,6 @@
 module Pcloud
   class Folder
-    class UnsuportedUpdateParams < StandardError; end
-    class ManformedUpdateParams < StandardError; end
+    class InvalidParameter < StandardError; end
     class InvalidParameters < StandardError; end
     class MissingParameter < StandardError; end
 
@@ -9,6 +8,7 @@ module Pcloud
     include Pcloud::TimeHelper
 
     SUPPORTED_UPDATE_PARAMS = [:name, :parent_folder_id, :path].freeze
+    SUPPORTED_FIND_BY_PARAMS = [:id, :path].freeze
 
     attr_reader :id, :path, :name, :parent_folder_id, :is_deleted, :created_at,
                 :modified_at
@@ -32,10 +32,10 @@ module Pcloud
 
     def update(params)
       unless (params.keys - SUPPORTED_UPDATE_PARAMS).empty?
-        raise UnsuportedUpdateParams.new("Must be one of #{SUPPORTED_UPDATE_PARAMS}")
+        raise InvalidParameters.new("Must be one of #{SUPPORTED_UPDATE_PARAMS}")
       end
       if params[:path] && is_invalid_path_param?(params[:path])
-        raise ManformedUpdateParams.new(":path param must start and end with `/`")
+        raise InvalidParameter.new(":path parameter must start and end with `/`")
       end
       query = {
         folderid: id,
@@ -103,14 +103,12 @@ module Pcloud
       end
 
       def find_by(params)
-        raise MissingParameter.new(":path or :id is required") unless params[:path] || params[:id]
+        unless (params.keys - SUPPORTED_FIND_BY_PARAMS).empty?
+          raise InvalidParameters.new("Must be one of #{SUPPORTED_FIND_BY_PARAMS}")
+        end
         raise InvalidParameters.new(":id takes precedent over :path, please only use one or the other") if params[:path] && params[:id]
-        parse_one(
-          Client.execute(
-            "listfolder",
-            query: { path: params[:path], folderid: params[:id] }.compact
-          )
-        )
+        query = { path: params[:path], folderid: params[:id] }.compact
+        parse_one(Client.execute("listfolder", query: query))
       end
     end
   end

data/lib/pcloud/version.rb

@@ -1,3 +1,3 @@
 module Pcloud
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pcloud_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Joshua Hunsche Jones