wormholio 0.0.2.6 → 0.0.2.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTA3MDFhYWNmZGMzZGMyODdjZTQ5ZGE4ZTdjMTcxMTUxZTkxZmFjOA==
+    ZTZlMmIyZTI0YjA1MDA0NWRhNTk4MWUyOGM1NmFiNjEwZDlmYjIxMQ==
   data.tar.gz: !binary |-
-    NjI0YWE4MGEwY2YwMWFlY2VhZmU0ZTI1MDU0NDkwZDNjZjFmZmNjYQ==
+    NDRjNjRiNTg1MGE1YWE4MDBiNjU0OTlmNDBlOGRlMzEwODRjMTQwMw==
 SHA512:
   metadata.gz: !binary |-
-    ODE4NTEyMmM4ODM2ZmVmZjBhZDQxZDE1ZGM5MDY0ZDk0ZGEyNmZiYzhlOTE4
-    N2YyYmZiZjg1NjdkODMyY2JkZGEzOTA0NzNiNzAyYmYwNThiYzkxZjgxNzc3
-    YWYxMTlmODMwYTA2MmQyYzMyOTAwMGQxZTRjODNmNGU0NThlZDI=
+    NTc5NzFlYWE4NGU5ODk2NzJmZWFlOWY0ODZmNDVjNTFmOGY5YjA3NWRlNmY2
+    NTA3M2NlOGFjYjg2OWI1ZGZiNWI1ZjM2MDVmYThjMjU3NzZkMzY3NzM0Yjk5
+    OTZjNjBjZjM1N2RmMDdkMGQ1NjYyODMwYjRjM2I1ZWUzM2M4YWY=
   data.tar.gz: !binary |-
-    ZmNjODc1NThlMjk5YTdkNzM0NTkyZGUyNGNhYjJlNTE0NDE1NmFjZGQ3Mzdm
-    MzAzYThkMzQ4NjhhMDlmNmY0ZDk0ZjFkOTI1ZGYyY2MxMDcwODYxMWI1ODhk
-    OGMyMzlkMTE4YTc0ZTI0YTcyODhhOTI1NzZlN2EzMmM2YTFiNWY=
+    NmNlYzdjNGYxZmEyNTE4MGViZjQ3MWFhZGMwOWZiNTRjNzY1YWZiMGFkMmU0
+    MzY4Y2E2MWE2YjdmYmIxZGQ0NDE2ZDEyNTRkYTIzZTk0ODUzY2MxYzUyMDMx
+    ZTNlYzFkZmJjY2E5ZTI5YTQ1NGQ5OWFlNzYzZmQyNmZmNDM4ZTA=

data/README.md

@@ -22,7 +22,130 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### FTP:
+- **Note:** dir_path should look like "/folder/"; be sure to prepend/append "/"
+
+```
+hash = {
+  'host':'www.domain.com',     # domain to connect to
+  'username':'steven',         # username
+  'password':'Steve1',         # user's password
+  'dir_path':'/home/',         # directory path on server
+  'port':'21'                  # will default to 21 if not specified
+}
+options = {"debug"=>true}         # If debug set to true, will return errors for testing
+
+file = "#{Rails.root}/file.json"  # Path/name of file to upload
+
+  # To upload
+  Wormholio::FTP.upload( hash, file, options )
+
+local_path = "#{Rails.root}/"     # Where to download file to
+filename = "file.json"            # Name of file
+
+  # To download
+  Wormholio::FTP.download( hash, local_path, filename, options )
+```
+
+### FTPS:
+- **Note:** dir_path should look like "/folder/"; be sure to prepend/append "/"
+
+```
+hash = {
+  'host':'www.domain.com',     # domain to connect to
+  'username':'steven',         # username
+  'password':'Steve1',         # user's password
+  'dir_path':'/home/',         # directory path on server
+  'port':'21'                  # will default to 21 if not specified
+}
+options = {"debug"=>true}         # If debug set to true, will return errors for testing
+
+file = "#{Rails.root}/file.json"  # Path/name of file to upload
+
+  # To upload
+  Wormholio::FTPS.upload( hash, file, options )
+
+local_path = "#{Rails.root}/"     # Where to download file to
+filename = "file.json"            # Name of file
+
+  # To download
+  Wormholio::FTPS.download( hash, local_path, filename, options )
+```
+
+### SFTP:
+- **Note:** dir_path should look like "/folder/"; be sure to prepend/append "/"
+
+```
+hash = {
+  'host':'www.domain.com',     # domain to connect to
+  'username':'steven',         # username
+  'password':'Steve1',         # user's password
+  'dir_path':'/home/',         # directory path on server
+  'port':'21'                  # will default to 21 if not specified
+}
+options = {"debug"=>true}         # If debug set to true, will return errors for testing
+
+file = "#{Rails.root}/file.json"  # Path/name of file to upload
+
+  # To upload
+  Wormholio::SFTP.upload( hash, file, options )
+
+local_path = "#{Rails.root}/"     # Where to download file to
+filename = "file.json"            # Name of file
+
+  # To download
+  Wormholio::SFTP.download( hash, local_path, filename, options )
+```
+
+### SCP:
+- **Note:** dir_path should look like "/folder/"; be sure to prepend/append "/"
+
+```
+hash = {
+  'host':'www.domain.com',     # domain to connect to
+  'username':'steven',         # username
+  'password':'Steve1',         # user's password
+  'dir_path':'/home/',         # directory path on server
+  'port':'21'                  # will default to 21 if not specified
+}
+options = {"debug"=>true}         # If debug set to true, will return errors for testing
+
+file = "#{Rails.root}/file.json"  # Path/name of file to upload
+
+  # To upload
+  Wormholio::SCP.upload( hash, file, options )
+
+local_path = "#{Rails.root}/"     # Where to download file to
+filename = "file.json"            # Name of file
+
+  # To download
+  Wormholio::SCP.download( hash, local_path, filename, options )
+```
+
+### S3:
+- **Note:** dir_path should look like "folder/"; be sure to append "/" to this
+
+```
+hash = {
+  'bucket_name':'bucket-name',           # domain to connect to
+  'access_key_id':'big-ole-access-key',  # username
+  'secret_access_key':'big-ole-secret',  # user's password
+  'dir_path':'folder/'                   # directory path on server
+}
+
+local_path = "#{Rails.root}/"               # Path to file we want to upload
+filename = "file.json"                      # Name of file to upload
+
+  # To upload
+  Wormholio::S3.upload( hash, local_path, filename )
+
+local_path = "#{Rails.root}/"               # Path to download file to
+filename = "file.json"                      # Name we want download file to have
+
+  # To download
+  Wormholio::S3.download( hash, local_path, filename )
+```
+
 
 ## Contributing
 

data/lib/wormholio/version.rb

@@ -1,3 +1,3 @@
 module Wormholio
-  VERSION = "0.0.2.6"
+  VERSION = "0.0.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wormholio
 version: !ruby/object:Gem::Version
-  version: 0.0.2.6
+  version: 0.0.2.7
 platform: ruby
 authors:
 - Christopher Reynolds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: double-bag-ftps
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: (under development) Simple Upload/Download functionality for FTP, FTPS, SFTP,