pcloud 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb75c427f836b4d247ec4fcf9274d241602f56b42b9db36f4b2933b032f65c9e
-  data.tar.gz: 8ac6d05ace840e3e97da605b639f1a1aba3d8f47d8fb3d2e015334b2c6fd2ade
+  metadata.gz: f947200228e5097393b62dfec894cb23446ab98aa6a5cae771df06f7aa857157
+  data.tar.gz: a112e53a402bf4ff3712d97c4ebf6bab0a1d45344c3cec64c7166c530cec2d4d
 SHA512:
-  metadata.gz: 0c5817e6034dbcb5f68c92c5d075c610ee37dbcb57cc7a38c79ece949634d3d8f56065ba1b906af9950e56943729964ca99697c30abbf5d6136a18d18bcc29dc
-  data.tar.gz: 9ca0c32931e65cc3a52bd0e64ba8767481599b357a91ca69f789162f875641101b225c8f581f125d548ece41fe888b010da53eccec5d274bd59db2353685e7f0
+  metadata.gz: f9268db7b79edd81d07ab7e4e6f927749dd862ec4de3ebb1abcaf32198c2dcf1844e28a6b3c884ccf0776df3e2cd2024ae0593a093bd9c92b2f296d8e08886ab
+  data.tar.gz: e21f80afd09d7e397835c2ab2d6e88bb76f30999b5e2da60f53ed942bf11976bba044554b2c74c97659803b5a8e7215302d2f4d0290940678d934c5cb64749eb

data/CHANGELOG.md

@@ -1,14 +1,73 @@
 # Changelog
 
-## 0.1.0 (2021-08-19)
+### [0.3.1](https://www.github.com/7urkm3n/pcloud/compare/v0.3.0...v0.3.1) (2021-09-04)
+
+
+### Bug Fixes
+
+* version update ([9bf5268](https://www.github.com/7urkm3n/pcloud/commit/9bf52681a94e6b17ec721778bfaeee39c1750a36))
+
+## [0.3.0](https://www.github.com/7urkm3n/pcloud/compare/v0.2.0...v0.3.0) (2021-09-04)
+
+
+### ⚠ BREAKING CHANGES
 
+* initialization
+
+### Bug Fixes
+
+* initialization ([6dc7735](https://www.github.com/7urkm3n/pcloud/commit/6dc77359c4bd3003ad05ed54705bfa70a6a95e62))
+
+## [0.2.0](https://www.github.com/7urkm3n/pcloud/compare/v0.1.0...v0.2.0) (2021-09-04)
+
+
+### ⚠ BREAKING CHANGES
+
+* major update
 
 ### Features
 
-* version 0.1.0 ([bafbe4b](https://www.github.com/7urkm3n/pcloud/commit/bafbe4b1d0301eb99446c703176eb35d6dc41336))
+* major update ([3c1a191](https://www.github.com/7urkm3n/pcloud/commit/3c1a1914606391739f08e29c264528ba3d02d112))
 
+## 0.1.0 (2021-08-19)
+
+### Features
+
+- version 0.1.0 ([bafbe4b](https://www.github.com/7urkm3n/pcloud/commit/bafbe4b1d0301eb99446c703176eb35d6dc41336))
 
 ### Bug Fixes
 
-* fixing workflow ([858cab4](https://www.github.com/7urkm3n/pcloud/commit/858cab495be548013c3e61756e626ce17cd38db3))
-* workflows works, testing version auto bump ([9de8276](https://www.github.com/7urkm3n/pcloud/commit/9de82767c31c1ae003e268910b23108bba4f2e8c))
+- fixing workflow ([858cab4](https://www.github.com/7urkm3n/pcloud/commit/858cab495be548013c3e61756e626ce17cd38db3))
+- workflows works, testing version auto bump ([9de8276](https://www.github.com/7urkm3n/pcloud/commit/9de82767c31c1ae003e268910b23108bba4f2e8c))
+
+#### v0.0.4
+
+##### Updates
+
+- Minor changes
+- Upload and Download added and avilable now
+- Post method is avilable now.
+- Upload/Download async version is on work.
+
+#### v0.0.3
+
+##### Updates
+
+- Minor updates
+- Upload and Download added - needs maintain
+- Post method fixed and added back
+
+#### v0.0.2
+
+##### Updates
+
+- Minor updates
+- Test files added
+- Removed `Post` method temporarily
+
+#### v0.0.1
+
+##### Publish
+
+- Available get Method
+- Incoming {Upload|Download} files

data/README.md

@@ -2,25 +2,28 @@
 
 This Gem provides a Ruby interface to [Pcloud.com](https://docs.pcloud.com).
 
-[![Build Status](https://github.com/7urkm3n/pcloud/workflows/build/badge.svg?branch=master)](https://github.com/7urkm3n/pcloud/actions?query=workflow%3Abuild) [![Gem Downloads](https://badgen.net/rubygems/dt/pcloud)](https://rubygems.org/gems/pcloud) [![Gem Version](https://badge.fury.io/rb/pcloud.svg)](https://badge.fury.io/rb/pcloud)
+[![Build Status](https://github.com/7urkm3n/pcloud/workflows/release/badge.svg?branch=main)](https://github.com/7urkm3n/pcloud/actions?query=workflow%3Arelease) [![Gem Downloads](https://badgen.net/rubygems/dt/pcloud)](https://rubygems.org/gems/pcloud) [![Gem Version](https://badge.fury.io/rb/pcloud.svg)](https://badge.fury.io/rb/pcloud)
 
 <!-- [![Gem Version](https://badgen.net/rubygems/v/pcloud)](https://rubygems.org/gems/pcloud) -->
 
+##### Want to contribute? [Doc Link](https://github.com/7urkm3n/pcloud/CONTRIBUTE.md)
+
 ## Installation and Configuration
 
 Add `pcloud` to your Gemfile, and then run `bundle install`
 
-``` ruby
+```ruby
 gem 'pcloud'
 ```
 
 or install via gem
 
-``` bash
+```bash
 gem install pcloud
 ```
 
 ###### Rails
+
 to generate `Rails` initializer file
 
 ```bash
@@ -35,87 +38,109 @@ config/initializers/pcloud.rb
 
 ### Instantiating a client
 
-``` ruby
+```ruby
 require 'pcloud'
 
 pcloud = Pcloud::Client.new(
   username: 'email',
   password: 'password',
-)
-```
+).authenticate
 
+pcloud.get("listfolder", folderid: 0)
+```
 
 ### Global configuration
 
 The library can also be configured globally on the `Pcloud` class.
 
-``` ruby
+```ruby
 Pcloud.username = 'email'
 Pcloud.password = 'password'
+Pcloud.authenticate
+
+Pcloud.get("listfolder", folderid: 0)
 ```
 
-<!-- ### Logging
+### Logging
 
 By default errors are logged in STDOUT level, also `Rails.logger` available.
 
-``` ruby
+```ruby
 Pcloud.logger = Rails.logger
-``` -->
+```
+
+### Working with methods
 
-## Working with methods
+Available methods:
 
-Currently, only available custom Get method. 
+- <b> Get </b>
+- <b> Post </b>
+- <b> File handling </b>
 
-File Upload and Download methods are coming soon.
+###### addition!
 
+> Some apis need to be `raw` format, just add `raw` in params. `params: {fileid: ..987, raw: true}`
+> For example `gettextfile` https://docs.pcloud.com/methods/streaming/gettextfile.html
 
-#### Get methods
+#### Get method
 
-``` ruby
+```ruby
 Pcloud.get("getip")
 Pcloud.get("getdigest")
 
 # with params
-Pcloud.get("listfolder", folderid: 0)
+params = {folderid: 0}
+Pcloud.get("listfolder", params)
 ```
-<!-- Pcloud.get("createfolder", folderid: 0, name: "new folder name", ...) -->
-
-#### Post methods
 
-``` ruby
-# if any of pcloud endpoints requires payload on POST request, please create an issue.
+#### Post method
 
-# with params
-Pcloud.post("createfolder", folderid: 0, name: "new folder name")
+```ruby
+payload = {}
+params = {folderid: 0, name: "new folder name"}
+Pcloud.post("createfolder", payload, params)
 ```
 
-#### [Files](https://docs.pcloud.com/methods/file/)
+### [File methods](https://docs.pcloud.com/methods/file/)
+
 ##### [Download File](https://docs.pcloud.com/methods/file/downloadfile.html)
 
-``` ruby
-#obtain filelink from: https://docs.pcloud.com/methods/streaming/getfilelink.html
+```ruby
+# optional params: filename, destination
+# destination by default current_path
+Pcloud.file.download({fileid: 987532135})
 
 Pcloud.file.download(
-  url: filelink,                           #required
-  destination: "#{Dir.pwd}/Downloads",     #required
-  filename: "hehe.txt"                     #optional
+  fileid: 987532135,                   #required
+  destination: "#{Dir.pwd}/Downloads", #optional
+  filename: "hehe.txt"                 #optional
 )
 ```
 
-##### [Upload File](https://docs.pcloud.com/methods/file/uploadfile.html)
+##### [Download Folder](#)
 
-``` ruby
-# still in BETA! -  
-# only supports single file upload
+```ruby
+# optional params: filename, destination
+# destination by default current_path
+Pcloud.file.download_folder({folderid: 123456789})
+```
+
+##### [Upload File](https://docs.pcloud.com/methods/file/uploadfile.html)
 
-file = File.open("/Users/7urkm3n/Downloads/anything.file")
+```ruby
 params = {
-  folderid: 0,                #required
-  filename: "anything.txt"    #required
+  folderid: 0,  #required
+  nopartial: 1,
 }
-payload = {file: file}
+# multiple uploads
+file1 = File.open("./Rakefile")
+file2 = File.open("./README.md")
+file3 = File.open("./Gemfile")
+payload = { files: [file1,file2,file3] }
+
 Pcloud.file.upload(params, payload)
 ```
 
 ### Supported Ruby versions
+
 2.2+

data/lib/pcloud/client.rb

@@ -1,51 +1,64 @@
 require 'json'
 require 'rest-client'
+require_relative './request'
+require_relative "./files/file_handler"
 
 module Pcloud
   class Client
     attr_writer :username, :password
+    attr_accessor :auth_token
 
     def initialize(options = {})
       @username, @password = options.values_at(:username, :password)
+      @auth_token = options[:auth_token]
     end
 
-    def get(path, params = {})
-      resource(path).get(params)
+    def get(path, params={})
+      request(:get, path, params)
     end
 
-    def post(path, params = {})
-      resource(path).post(params)
+    def post(path, payload={}, params={})
+      request(:post, path, params, payload)
     end
 
     def file
-      Resource.new(self).file()
+      @file ||= FileHandler.new(self)
     end
 
     def http_client
-      @client ||= RestClient::Resource.new(BASE_URL)
+      @http_client ||= RestClient::Resource.new(BASE_URL)
     end
 
-    def auth
-      @auth ||= begin
-        raise ConfigurationError, :username unless @username
-        raise ConfigurationError, :password unless @password
-        digest = JSON.parse(RestClient.get("#{BASE_URL}/getdigest"))['digest']
-        passworddigest = digest_data(@password + digest_data( @username.downcase ) + digest)
-        JSON.parse(
-          RestClient.get("#{BASE_URL}/userinfo?getauth=1&logout=1", 
-          {params: {username: @username, digest: digest, passworddigest: passworddigest}})
-        )['auth']
-      end
+    def authenticate(options = {})
+      @auth_token = authorize(options)['auth']
+      self
     end
 
-    private
+  private
 
-    def resource(path)
-      Resource.new(self, path)
+    def request(verb, path, params, payload = {})
+      Pcloud::Request.call(self, verb, path, params, payload)
+    end
+
+    def authorize(options)
+      raise ConfigurationError, :username unless @username
+      raise ConfigurationError, :password unless @password
+      digest = JSON.parse(RestClient.get("#{BASE_URL}/getdigest"))['digest']
+      passworddigest = digest_data(@password + digest_data( @username.downcase ) + digest)
+      [:username, :digest, :passworddigest, :password].each { |k| options.delete(k) }
+      params = {params: {
+        username: @username, 
+        digest: digest, 
+        passworddigest: passworddigest,
+        device: "pcloud-ruby",
+        getauth: 1
+      }.merge!(options)}
+      JSON.parse(RestClient.get("#{BASE_URL}/userinfo", params)) #['auth']
     end
 
     def digest_data text
       Digest::SHA1.hexdigest(text)
     end
+    
   end
 end

data/lib/pcloud/files/file_handler.rb

@@ -1,35 +1,51 @@
-require 'rest-client'
+require 'open-uri'
+require 'zip'
 
 module Pcloud
   class FileHandler
+
     def initialize(client)
       @client = client
     end
 
     def upload(params, payload)
-      create_request(:post, 'uploadfile', params, payload).call
+      request(:post, 'uploadfile', params, payload)
     end
 
     def download(params)
-      url = params[:url]
-      begin
-        res = RestClient.get(url)
-      rescue => e
-        raise HTTPError.new(:HTTPError, e.message)
+      # destination = params[:destination] ? params[:destination] : '.'
+      # data = request(:get, "getfilelink", {fileid: params[:fileid], forcedownload: 1})
+      # url = "https://#{data[:hosts][0]+data[:path]}"
+      # IO.copy_stream(URI.open(url), "#{destination}/#{url.split("/").last}")
+      # File.write("#{destination}/#{url.split("/").last}", URI.open(url).read)
+
+      destination = params[:destination] || '.'
+      filename = params[:filename] || nil
+      if !filename
+        stat = request(:get, "stat", {fileid: params[:fileid]})
+        filename = stat[:metadata][:name]
       end
-      
-      filename = params[:filename] ? params[:filename] : url.split("/").last
-      File.open("#{params[:destination]}/#{filename}", 'wb' ) do |f|
-        f.write res
+      File.write("#{destination}/#{filename}", request(:get, "gettextfile", {fileid: params[:fileid], raw: true}))
+    end
+
+    def download_folder(params)
+      data = request(:get, "listfolder", {folderid: params[:folderid]})
+      destination = params[:destination] || '.'
+      folder_name = params[:filename] || data[:metadata][:name] << ".zip"
+      stringio = Zip::OutputStream::write_buffer do |zio|
+        data[:metadata][:contents].each do |content|
+          zio.put_next_entry(content[:name])
+          zio.write(request(:get, "gettextfile", {fileid: content[:fileid], raw: true}))
+        end
       end
-      res.code
+      stringio.rewind #reposition buffer pointer to the beginning
+      File.new("#{destination}/#{folder_name}","wb").write(stringio.sysread) #write buffer to zipfile
     end
 
-    private
+  private
 
-    def create_request(verb, path, params, payload = {})
-      Request.new(@client, verb, path, params, payload)
+    def request(verb, path, params, payload = {})
+      Pcloud::Request.call(@client, verb, path, params, payload)
     end
-    
   end
 end

data/lib/pcloud/request.rb

@@ -1,46 +1,43 @@
 module Pcloud
-  class Request
-    def initialize(client, verb, path, params, payload)
-      @client, @verb, @path, @params, @payload = client, verb, path, params, payload
-    end
-
-    def call
-      params = {params: {}}
-      params[:params].merge!(@params, {auth: @client.auth})
-      http = @client.http_client
-      res = case @verb
-            when :get
-              begin
-                http[@path].get(params)
-              rescue => e
-                handle_response(e.http_code, e.message)
-              end
-            when :post
-              begin
-                http[@path].post(@payload, params)
-              rescue => e
-                handle_response(e.http_code, e.message)
+  module Request
+    class << self
+      def call(client, verb, path, params, payload={})
+        params = {params: {}.merge!(params, {auth: client.auth_token})}
+        http = client.http_client
+        res = case verb
+              when :get
+                begin
+                  http[path].get(params)
+                rescue => e
+                  handle_response(e.http_code, e.message)
+                end
+              when :post
+                begin
+                  http[path].post(payload, params)
+                rescue => e
+                  handle_response(e.http_code, e.message)
+                end
+              else
+                raise "Unsupported verb (get and post available): #{verb}"
               end
-            else
-              raise "Unsupported verb: #{@verb}"
-            end
-      JSON.parse(res.body, { symbolize_names: true })
-    end
+        return res.body if params[:params][:raw]
+        JSON.parse(res.body, { symbolize_names: true })
+      end
 
     private
 
-    def handle_response(status_code, body)
-      case status_code
-      when 400
-        raise HTTPError.new(:HTTPError, body)
-      when 401
-        raise AuthenticationError, body
-      when 404
-        raise HTTPError.new(:HTTPError, body)
-      else
-        raise Error, "Unknown error (status code #{status_code}): #{body}"
+      def handle_response(status_code, body)
+        case status_code
+        when 400
+          raise HTTPError.new(:HTTPError, body)
+        when 401
+          raise AuthenticationError, body
+        when 404
+          raise HTTPError.new(:HTTPError, body)
+        else
+          raise Error, "Unknown error (status code #{status_code}): #{body}"
+        end
       end
     end
-
   end
 end

data/lib/pcloud/version.rb

@@ -1,3 +1,3 @@
 module Pcloud
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/pcloud.rb

@@ -1,18 +1,21 @@
 autoload 'Logger', 'logger'
 require 'forwardable'
-require 'pcloud/client'
+require_relative 'pcloud/client'
 
 module Pcloud
   BASE_URL = 'https://api.pcloud.com'.freeze
 
   class << self
     extend Forwardable
-    def_delegators :default_client, :username=, :password=
-    def_delegators :default_client, :get, :post
-    def_delegators :default_client, :file
+    def_delegators :client, :auth_token=, :username=, :password=
+    def_delegators :client, :get, :post, :file, :authenticate
 
     attr_writer :logger
 
+    def client
+      @client ||= Pcloud::Client.new
+    end
+
     def logger
       @logger ||= begin
         log = Logger.new($stdout)
@@ -21,13 +24,8 @@ module Pcloud
       end
     end
 
-    def default_client
-      @default_client ||= Pcloud::Client.new
-    end
   end
 end
 
-require 'pcloud/version'
-require 'pcloud/request'
-require 'pcloud/resource'
-require 'pcloud/exceptions'
+require_relative './pcloud/version'
+require_relative './pcloud/exceptions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pcloud
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rovshen Gurdov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.2
 description: Pcloud is cloud storage upload/download/share from pcloud.com. Please,
   check available methods in Github Doc...
 email:
@@ -70,7 +70,6 @@ files:
 - lib/pcloud/exceptions.rb
 - lib/pcloud/files/file_handler.rb
 - lib/pcloud/request.rb
-- lib/pcloud/resource.rb
 - lib/pcloud/version.rb
 homepage: https://github.com/7urkm3n/pcloud
 licenses:

data/lib/pcloud/resource.rb

@@ -1,29 +0,0 @@
-require "pcloud/files/file_handler"
-
-module Pcloud
-  class Resource
-
-    def initialize(client, path = "")
-      @client, @path = client, path
-    end
-
-    def get(params)
-      create_request(:get, params).call
-    end
-
-    def post(params, payload = {})
-      create_request(:post, params, payload).call
-    end
-
-    def file
-      @file ||= FileHandler.new(@client)
-    end
-    
-    private
-
-    def create_request(verb, params, payload = {})
-      Request.new(@client, verb, @path, params, payload)
-    end
-
-  end
-end