pcloud_api 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc8c976ed07fce0322907df07ed86d464b5924e6fb465aaa2bc5154b5fe95e8
-  data.tar.gz: e86aaee5ef4453da35281d3d3840078dfc639552c8913de6f4389a571e862256
+  metadata.gz: fcef0e50f4deec3483d2ce4f23882a453ed3cea1fac57ef507ee1523824aba33
+  data.tar.gz: 287a6037d5f81652a936d611a69cd2b40dd4ce5cdfbde03093242e0bcc7e061a
 SHA512:
-  metadata.gz: a75daa528c2c263b4f5e1e2f57e81090a440c391860ef5bfc714967156cfe5b289c1b3d644428f5213e13c60fabca6745263d7cc6c7ba77c800d6177d8e1a888
-  data.tar.gz: 520875db136cfb2961b8bdee6f9948af3701aaef3eb318860ec7b7b018fd7ac500edc27ea0581765ce5e63e948dea842bd7a94a85ba3279323ec14fa21d91915
+  metadata.gz: b9cc930698584cfebe1fbb501798cb15ccb8116e8d231f632c30813f37bc0912550cee1d3bcdfee66fd21add00e8d2874b8471173ca4c77b67a544b7efe2740a
+  data.tar.gz: ecdc92c74476eaed41515b5206d5c428f17fcddf870cd28f162fd382ba97abd11d095ef36ded8f155a188a36fe7a32afc4703df7275a779ec37628281de3da58

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.3 2021-12-14
+
+**Changes**
+  1. `Pcloud::File`'s `upload` method no longer requires a `:filename` param, since pCloud just reads it off of the file object and ignores the param anyway
+  2. Both `Pcloud::File` and `Pcloud::Folder`'s `update` and `update!` methods now allow either partial paths _(starting and ending with slashes)_ or full paths. This is a little more dangerous if you specify a full path and you meant partial, but it's a reasonable use case to support.
+
 ## 0.2.2 2021-10-09
 
 **Changes**

data/README.md

@@ -1,6 +1,8 @@
 # pCloud API
 
 [![CI](https://github.com/jhunschejones/pcloud_api/actions/workflows/ci.yml/badge.svg)](https://github.com/jhunschejones/pcloud_api/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/pcloud_api.svg)](https://badge.fury.io/rb/pcloud_api)
+[![Gem Downloads](https://badgen.net/rubygems/dt/pcloud_api)](https://rubygems.org/gems/pcloud_api)
 
 The `pcloud_api` gem provides an intuitive Ruby interface for interacting with the [pCloud API](https://docs.pcloud.com/) using OAuth2. This gem does not attempt to replicate the entire functionality of the pCloud API but rather to provide quick and easy access for its most basic and common functionality. If you are looking for a lower-level pCloud API wrapper, [`pcloud`](https://github.com/7urkm3n/pcloud) might be a better fit for you.
 
@@ -9,7 +11,7 @@ The `pcloud_api` gem provides an intuitive Ruby interface for interacting with t
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pcloud_api'
+gem "pcloud_api"
 ```
 
 And then execute:
@@ -28,6 +30,10 @@ Or install it yourself as:
 
 ## Usage
 
+### Generating an access token
+
+To use the `pcloud_api` client, you will need to first generate an access token. You may do this by cloning and running the script in [`./bin/generate_access_token`](https://github.com/jhunschejones/pcloud_api/blob/master/bin/generate_access_token). It will take you through the process of setting up a pCloud app and completing the OAuth2 flow in the browser.
+
 ### Configuration
 
 The `Pcloud::Client` can be configured by directly calling the `Pcloud::Client.configure` method in an initializer or somewhere else in your code at startup:
@@ -46,43 +52,50 @@ There are two main objects represented in the library, `Pcloud::File` and `Pclou
 
 The `Pcloud::File` API includes:
 ```ruby
-# Find files by file id or path:
+# Find files by file :id or :path:
 Pcloud::File.find(1)
 Pcloud::File.find_by(path: "/images/jack_the_cat.jpg")
-# NOTE: find_by can also be used with :id, though this will take precedence
+# NOTE: `find_by` can also be used with :id, though this will take precedence
 # over :path so just pick one or the other
 
-# Check if a file exists by id
+# Check if a file exists by :id
 Pcloud::File.exists?(1)
 
 # Upload a new file, rename if one already exists with this name:
 Pcloud::File.upload(
-  folder_id: 1,
-  filename: "jack_goes_swimming.mp4",
+  path: "/Jack",
   file: File.open("/Users/joshua/Downloads/jack_goes_swimming.mp4")
 )
-# NOTE: the upload method will allow you to specify the :path or the :folder_id
-# or you can choose to pass neither paramenter and your files will be placed
-# in your root pCloud directory.
 
-# Upload a file, force overwrite of existing file:
+# Upload a file, force overwrite if a file already exists with this name:
 Pcloud::File.upload!(
-  folder_id: 1,
-  filename: "jack_goes_swimming.mp4",
+  path: "/Jack",
   file: File.open("/Users/joshua/Downloads/jack_goes_swimming.mp4")
 )
 
+# NOTE:
+# The `upload` and `upload!` methods will allow you to specify either the :path
+# or the :folder_id of the target parent directory, or you can choose to pass
+# neither paramenter and your files will be placed in your root pCloud
+# directory by default.
+
 # Rename a file:
 jack_goes_swimming.update(name: "That's one wet cat.mp4")
 
-# Move a file by updating the parent_folder_id or path:
+# Move a file by updating the :parent_folder_id:
 jack_goes_swimming.update(parent_folder_id: 9000)
 
+# Move a file by specifying the parent folder part of the path:
+jack_goes_swimming.update(path: "/photos/") # NOTE: needs to start and end with slashes
+
+# Move a file by specifying the entire new file path:
+jack_goes_swimming.update(path: "/photos/jack_goes_swimming.mp4")
+
 # Delete a file:
 jack_goes_swimming.delete
 
 # Get a link to download a file:
-jack_goes_swimming.download_link
+jack_goes_swimming.download_url
 
 # Access the parent folder of a file:
 jack_goes_swimming.parent_folder
@@ -90,27 +103,37 @@ jack_goes_swimming.parent_folder
 
 The `Pcloud::Folder` API is very similar:
 ```ruby
-# Find folders by folder id or path:
+# Find folders by folder :id or :path:
 Pcloud::Folder.find(1)
 Pcloud::Folder.find_by(path: "/images")
-# NOTE: find_by can also be used with :id, though this will take precedence
+# NOTE: `find_by` can also be used with :id, though this will take precedence
 # over :path so just pick one or the other
 
 # Check if a folder exists by id
 Pcloud::Folder.exists?(1)
 
-# Create a new folder by parent_folder_id and name:
+# Create a new folder by :parent_folder_id and :name:
 Pcloud::Folder.first_or_create(parent_folder_id: 9000, name: "jack")
 
-# Create a new folder by path:
+# Create a new folder by :path (parent directory must already exist):
 Pcloud::Folder.first_or_create(path: "/images/jack")
 
 # Rename a folder:
 jack_images.update(name: "Jack's Photo Library")
 
-# Move a folder by updating the parent_folder_id or path:
+# Move a folder by updating the :parent_folder_id:
 jack_images.update(parent_folder_id: 9000)
 
+# Move a folder by specifying the parent folder part of the path:
+jack_images.update(path: "/photos/")
+# NOTES:
+# - Partial paths must start and end with slashes
+# - All refrenced parent directories in the path must already exist
+
+# Move a folder by specifying the entire new file path:
+jack_images.update(path: "/photos/images/jack")
+# NOTE: All refrenced parent directories in the path must already exist
+
 # Delete an empty folder:
 jack_images.delete
 
@@ -137,10 +160,6 @@ Pcloud::Client.execute("listrevisions", query: { fileid: 90000 })
 ```
 _(There are a few methods on the raw pCloud API that require manual login, which this gem does not yet support. If you find that you need access to these methods you may wish to look at using the [`pcloud`](https://github.com/7urkm3n/pcloud) gem instead.)_
 
-### Generating an access token
-
-To use the `pcloud_api` client, you will need to first generate an access token. You may do this by cloning and running the script in `./bin/generate_access_token`. It will take you through the process of setting up a pCloud app and completing the OAuth2 flow in the browser.
-
 ## 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/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/pcloud/client.rb

@@ -24,8 +24,8 @@ module Pcloud
           headers: { "Authorization" => "Bearer #{access_token}" },
           timeout: TIMEOUT_SECONDS # this sets both the open and read timeouts to the same value
         }
-        options.merge!({ query: query }) unless query.empty?
-        options.merge!({ body: body }) unless body.empty?
+        options[:query] = query unless query.empty?
+        options[:body] = body unless body.empty?
         response = HTTParty.public_send(verb, "https://#{closest_server}/#{method}", options)
         json_response = JSON.parse(response.body)
         raise ErrorResponse.new(json_response["error"]) if json_response["error"]
@@ -44,7 +44,7 @@ module Pcloud
       def access_token
         @@access_token ||= ENV["PCLOUD_API_ACCESS_TOKEN"]
         return @@access_token unless @@access_token.nil?
-        raise ConfigurationError.new("Missing bearer token")
+        raise ConfigurationError.new("Missing pCloud API access token")
       end
 
       # You can manually hit "https://<default_server_for_your_region>/getapiserver"

data/lib/pcloud/file.rb

@@ -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_update_param?(params[:path])
-        raise InvalidParameter.new(":path param must start and end with `/`")
+      if params[:path] && params[:path][0] != "/"
+        raise InvalidParameter.new(":path param must start with `/`")
       end
       query = {
         fileid: id,
@@ -73,13 +73,6 @@ module Pcloud
       "#{@download_url}/#{URI.encode_www_form_component(name)}"
     end
 
-    private
-
-    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
-
     class << self
       def exists?(id)
         find(id)
@@ -127,7 +120,7 @@ module Pcloud
             renameifexists: params[:overwrite] ? 0 : 1,
             path: params[:path],
             folderid: params[:folder_id],
-            filename: params.fetch(:filename),
+            filename: params[:filename],
             file: file,
           }.compact,
         )
@@ -136,7 +129,7 @@ module Pcloud
         # so we return just one file out of this method.
         uploaded_file = parse_many(response).first
         raise UploadFailed if uploaded_file.nil?
-        return uploaded_file
+        uploaded_file
       rescue KeyError => e
         missing_param = e.message.gsub("key not found: ", "")
         raise MissingParameter.new("#{missing_param} is required")

data/lib/pcloud/folder.rb

@@ -34,8 +34,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 InvalidParameter.new(":path parameter must start and end with `/`")
+      if params[:path] && params[:path][0] != "/"
+        raise InvalidParameter.new(":path parameter must start with `/`")
       end
       query = {
         folderid: id,
@@ -72,13 +72,6 @@ module Pcloud
       @contents
     end
 
-    private
-
-    def is_invalid_path_param?(path_param)
-      # Path params have to start and end with `/`
-      [path_param[0], path_param[-1]] != ["/", "/"]
-    end
-
     class << self
       def first_or_create(params)
         if params[:parent_folder_id] && params[:name]

data/lib/pcloud/version.rb

@@ -1,3 +1,3 @@
 module Pcloud
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pcloud_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Joshua Hunsche Jones
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - joshua@hunschejones.com
 executables: []
@@ -134,7 +134,7 @@ metadata:
   homepage_uri: https://github.com/jhunschejones/pcloud_api
   source_code_uri: https://github.com/jhunschejones/pcloud_api
   changelog_uri: https://github.com/jhunschejones/pcloud_api/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A Ruby library for interacting with the pCloud API
 test_files: []