my-dropbox-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abbb20e06ab8d1fb51d2d2f46a59d4fb53a2dcd86f8a90354f6dda52b13519b2
+  data.tar.gz: c81c047a173b64c303d166b12c5861d76f46a7528f3a0fd6ad68b0e7105e95be
+SHA512:
+  metadata.gz: 79283e682d26332777f34f90ed273ac70adace6bfb15db54b54661caf588bd76203ca210ef75d72a557b003c2a7251bbb641be0350967602d71c1c4b9f802dcb
+  data.tar.gz: 88abb7a05ad1452d6a1105b24c71c2670a8dd9b3b9d5488075ad73d34ee2a31b516c38ddda8b4516169bbb48c26da34739e0d22ca4e5f01e9c227df32a642049

data/lib/my-dropbox-api.rb

@@ -0,0 +1,235 @@
+require 'pry'
+require 'json'
+require 'blackstack-core'
+
+module BlackStack
+    module DropBox
+        DROPBOX_APP_KEY = 'lnystcoayzse5at'
+        
+        # ConnectionSphere API-KEY
+        @@connectionsphere_api_key = nil
+        @@connectionsphere_token_url = 'https://connectionsphere.com/api1.0/dropbox/get_access_token.json'
+        
+        # mysaas end-user "refresh-token" to grab a new "access-code" every time is needed.
+        @@dropbox_refresh_token = nil
+        # list of folders and files to backup
+        @@destinations = []
+
+        # getters 
+        def self.dropbox_refresh_token
+            @@dropbox_refresh_token
+        end
+
+        # getters 
+        def self.destinations
+            @@destinations
+        end
+
+        # Setup the bakcup module.
+        def self.set(h)
+            @@dropbox_refresh_token = h[:dropbox_refresh_token]
+            @@destinations = h[:destinations]
+            @@connectionsphere_api_key = h[:connectionsphere_api_key]
+        end # set
+
+        # Get a short-live access code using the refresh token.
+        # This method is for internal usage only.
+        # End-users should not call this method.
+        #
+        def self.dropbox_get_access_token
+            # get the refresh token
+            begin
+                params = {
+                  'api_key' => "#{@@connectionsphere_api_key}",
+                  'refresh_token' => "#{@@dropbox_refresh_token}"
+                }
+                res = BlackStack::Netting::call_post(@@connectionsphere_token_url, params)
+                h = JSON.parse(res.body)
+                raise h['status'] if h['status']!='success'
+
+                h['access_token']
+            rescue Errno::ECONNREFUSED => e
+                raise "Errno::ECONNREFUSED:#{e.message}"
+            rescue => e2
+                raise "Exception:#{e2.message}"
+            end
+        end
+
+        # Create a folder into dropbox
+        #
+        # This method is for internal use only.
+        # End-users should use the BlackStack::Backup::backup method.
+        # 
+        # use `2>&1 1>/dev/null` to suppress verbose output of shell command.
+        # reference: https://stackoverflow.com/questions/18525359/suppress-verbose-output-of-shell-command-in-python
+        def self.dropbox_create_folder(cloudfoldername)
+            s = "curl --silent -X POST https://api.dropboxapi.com/2/files/create_folder_v2 \\
+            --header \"Authorization: Bearer #{BlackStack::DropBox.dropbox_get_access_token}\" \\
+            --header \"Content-Type: application/json\" \\
+            --data \"{\\\"autorename\\\":false,\\\"path\\\":\\\"#{cloudfoldername}\\\"}\""
+            `#{s}`
+        end
+
+        # Upload a file to dropbox
+        #
+        # This method is for internal use only.
+        # End-users should use the BlackStack::Backup::backup method.
+        # 
+        # use `2>&1 1>/dev/null` to suppress verbose output of shell command.
+        # reference: https://stackoverflow.com/questions/18525359/suppress-verbose-output-of-shell-command-in-python
+        def self.dropbox_upload_file(localfilename, cloudfilename)
+            s = "curl --silent -X POST https://content.dropboxapi.com/2/files/upload \\
+            --header \"Authorization: Bearer #{BlackStack::DropBox.dropbox_get_access_token}\" \\
+            --header \"Dropbox-API-Arg: {\\\"path\\\": \\\"#{cloudfilename}\\\", \\\"mode\\\": \\\"overwrite\\\"}\" \\
+            --header \"Content-Type: application/octet-stream\" \\
+            --data-binary @#{localfilename}"
+            return `#{s}`
+        end
+
+        # Upload a files and folders to dropbox
+        #
+        # This method is for internal use only.
+        # End-users should use the BlackStack::Backup::backup method.
+        # 
+        # Iterate over directories and subdirectories recursively showing 'path/file'.
+        # reference: https://stackoverflow.com/questions/40016856/iterate-over-directories-and-subdirectories-recursively-showing-path-file-in-r
+        #
+        # localpath: pattern to list the files and folders to upload
+        # cloudpath: name of the cloud folder
+        #
+        # Return an array of each opeation performed, with the result of such operation.
+        #
+        def self.upload(localpath, cloudpath)
+            # drop last / from cloudpath
+            cloudpath.strip!
+            cloudpath.gsub!(/\/$/, '')
+            # get the path from the ls command
+            local_folder = localpath.gsub(/\/#{Regexp.escape(localpath.split('/').last)}$/, '')
+            ret = [] # array
+            Dir.glob(localpath).each do |file|
+                # hash descriptor of this operation
+                h = {}
+                h[:file] = file
+                # decide if it is a file or a folder
+                type = File.directory?(file) ? 'folder' : 'file'
+                # remove the source from the path
+                file.gsub!(/^#{Regexp.escape(local_folder)}\//, '')
+                if type == 'file'
+                    h[:type] = 'file'
+                    h[:result] = BlackStack::DropBox.dropbox_upload_file("#{local_folder}/\"#{file}\"", "#{cloudpath}/\"#{file}\"")
+                    ret << h
+                else
+                    h[:type] = 'folder'
+                    h[:result] = BlackStack::DropBox.dropbox_create_folder("#{cloudpath}/#{file}")
+                    ret << h
+                    ret += BlackStack::DropBox.upload("#{local_folder}/#{file}/*", "#{cloudpath}/#{file}")
+                end # if type
+            end # Dir.glob
+            ret
+        end
+
+        # Run the backup process.
+        def self.backup(verbose=false, log=nil)
+            log = BlackStack::DummyLogger.new(nil) if log.nil?
+            timestamp = Time.now.getutc.to_s.gsub(/[^0-9a-zA-Z\.]/, '')
+            @@destinations.each { |d|
+                # parameters
+                foldername = d[:folder] # how to name this backup in dropbox 
+                source = d[:source] # source folder to backup
+
+                # build a unique folder name using the current timestamp.
+                log.logs "#{foldername}... "
+                    folder = "#{timestamp}.#{foldername}"
+                    
+                    log.logs "Create folder #{folder}... "
+                    BlackStack::DropBox::dropbox_create_folder(folder, verbose)
+                    log.done
+                    
+                    log.logs "Upload files... "
+                    BlackStack::DropBox::upload(folder, source, verbose, log)
+                    log.done
+                log.done
+            }
+        end
+
+        # Run the restore process
+        #
+        # NOTE: Download a folder from the user's Dropbox, as a zip file. 
+        # The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size. 
+        # The resulting zip must have fewer than 10,000 total file and folder entries, including the top level folder. 
+        # The input cannot be a single file. Note: this endpoint does not support HTTP range requests.
+        # 
+        # Reference: https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip
+        # 
+        # Parameters: 
+        # - cloudfoldername: name of the folder in dropbox to download. The zip file will be saved in the folder where the command is running.
+        # - zipfilename: name of the zip file to save.
+        # - unzip: activate thisf lag if you want to unzip the downloaded zip file.
+        # - destination: path of the local folder where you want to unzip.
+        # - deletezipfile: activate this if you want to delete the zip file after unzipping.
+        #
+        # Activate the unzip if you have installed the zip command.
+        # Reference: https://iq.direct/blog/49-how-to-unzip-file-on-ubuntu-linux.html 
+        #
+        def self.restore(cloudfoldername, log=nil, zipfilename='temp.zip', unzip=false, destination=nil, deletezipfile=false)
+            log.logs 'Downloading backup folder... '
+            s = "curl --silent -X POST https://content.dropboxapi.com/2/files/download_zip \\
+            --header \"Authorization: Bearer #{BlackStack::DropBox.dropbox_get_access_token}\" \\
+            --header \"Dropbox-API-Arg: {\\\"path\\\":\\\"/#{cloudfoldername}/\\\"}\" --output #{zipfilename} 2>&1 1>/dev/null"
+            `#{s}`
+
+            log.done
+
+            if unzip
+                log.logs 'Unzipping backup folder... '
+                s = "
+                rmdir ./tempy 2>/dev/null;
+                mkdir ./tempy;
+                unzip #{zipfilename} -d ./tempy;
+                mv ./tempy/#{cloudfoldername}/* #{destination};
+                rm -rf ./tempy 2>/dev/null;
+                "
+                `#{s}`
+                log.done
+                if deletezipfile
+                    log.logs 'Deleting zip file... '
+                    `rm #{zipfilename}`
+                    log.done
+                end
+            end
+        end # def self.restore
+
+        def self.dropbox_download_file(cloudfoldername, cloudfilename, destination=nil)
+            s = "curl --silent -X POST https://content.dropboxapi.com/2/files/download \\
+            --header \"Authorization: Bearer #{BlackStack::DropBox.dropbox_get_access_token}\" \\
+            --header \"Dropbox-API-Arg: {\\\"path\\\":\\\"/#{cloudfoldername}/#{cloudfilename}\\\"}\" --output #{destination}/#{cloudfilename} 2>&1 1>/dev/null"
+            `#{s}`
+        end # def self.dropbox_download_file
+
+        # Reference: https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder
+        def self.dropbox_folder_files(cloudfoldername)
+            s = "curl --silent -X POST https://api.dropboxapi.com/2/files/list_folder \\
+            --header \"Authorization: Bearer #{BlackStack::DropBox.dropbox_get_access_token}\" \\
+            --header \"Content-Type: application/json\" \\
+            --data \"{\\\"include_deleted\\\":false,\\\"include_has_explicit_shared_members\\\":false,\\\"include_media_info\\\":false,\\\"include_mounted_folders\\\":true,\\\"include_non_downloadable_files\\\":true,\\\"path\\\":\\\"/#{cloudfoldername}/\\\"}\""
+            output = `#{s}`
+            ret = JSON.parse(output)
+            ret['entries'].map { |e| e['name'] }
+        end # def self.dropbox_folder_files
+
+        # Reference: https://www.dropbox.com/developers/documentation/http/documentation#sharing-create_shared_link_with_settings
+        def self.get_file_url(cloudfilename)
+            s = "curl --silent -X POST https://api.dropboxapi.com/2/sharing/create_shared_link_with_settings \\
+            --header \"Authorization: Bearer #{BlackStack::DropBox.dropbox_get_access_token}\" \\
+            --header \"Content-Type: application/json\" \\
+            --data \"{\\\"path\\\":\\\"#{cloudfilename}\\\",\\\"settings\\\":{\\\"access\\\":\\\"viewer\\\",\\\"allow_download\\\":true,\\\"audience\\\":\\\"public\\\",\\\"requested_visibility\\\":\\\"public\\\"}}\""
+            output = JSON.parse(`#{s}`)
+            raise "Error: #{output['error_summary']}" if output.has_key?('error_summary')
+            url = output["url"]
+            url.gsub!('www.dropbox.com', 'dl.dropboxusercontent.com') # Gsub domain
+            url.gsub!('dl=0', 'dl=1') # Enable download
+            url
+        end  # def self.get_file_url
+
+    end # module Extensions
+end # module BlackStack

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: my-dropbox-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Leandro Daniel Sardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: blackstack-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+description: "\nThe **dropbox-api** is a Ruby gem for managing DropBox uploading,
+  downloading and sharing DropBox files and folders.\n\nThe main goals of building
+  this gem are:\n  \n1. Simulate a **permanent access token**, since [Dropbox is moving
+  to \"short-term live access codes\"](https://www.dropboxforum.com/t5/Discuss-Dropbox-Developer-API/Permanent-access-token/td-p/592644);\n
+  \ \n2. Manage DropBox as an elastic-storage providers for [our SaaS projects](https://github.com/leandrosardi/mysaas),
+  allowing us to upload, download and share download links to files;\n  \n3. Backup
+  and restore secret files of our projects that cannot be commited into the source
+  code repository (E.g.: database passwords, SSL certificates, private keys).\n  "
+email: leandro@connectionsphere.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/my-dropbox-api.rb
+homepage: https://github.com/leandrosardi/my-dropbox-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Ruby gem to manage some basic DropBox operations.
+test_files: []