wetransfer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e0f327dda7a10e3f6b84555d9a3345b1542061c
-  data.tar.gz: 3800f908a5b774c44e297cdc1d5047fcdbb95ef7
+  metadata.gz: b127566b552bca3dc2cba123d42068d1da3d1207
+  data.tar.gz: a7a43758463d7b3843cca5dc9b63a725305626d2
 SHA512:
-  metadata.gz: 32550fa1fccece36ff52b75a95f7fc51e6d3d67bf90b6c63962b99671be5b6fa81b6576bbee71a786ee49dea7701450fc3a28007743edd30379bbea0917d3eb5
-  data.tar.gz: 4625e08a9cce1b5bf3f8df1ac209499cc488791b96bb2c18f9086f76ecb999261d3a8482ed2ac878af017f50813b4e6a14a20664f3521dfdaa1c37196634082e
+  metadata.gz: e9c63a68dd28022d301f792f6e4e32c6dacb028a37977ae7da6bf84c0508aa2d4e1adf8a69aa70210114fdc92670b27f568f27acdbd64904949abe963c7cce2c
+  data.tar.gz: f32301712449dc9f4d7298356978d8802c4b82a2df9109a8222b18ac25555de568a2cd83ab371ee4a55a1d4bba8b280cd185aae6f344825c6dcb1363326b5eea

data/{CONTRIBUTING.md → .github/CONTRIBUTING.md}

@@ -106,11 +106,11 @@ project:
 
    ```bash
    # Clone your fork of the repo into the current directory
-   git clone git@github.com:WeTransfer/wetransfer.git
+   git clone git@github.com:WeTransfer/wetransfer_ruby_sdk.git
    # Navigate to the newly cloned directory
-   cd wetransfer
+   cd wetransfer_ruby_sdk
    # Assign the original repo to a remote called "upstream"
-   git remote add upstream git@github.com:WeTransfer/wetransfer.git
+   git remote add upstream git@github.com:WeTransfer/wetransfer_ruby_sdk.git
    ```
 
 2. If you cloned a while ago, get the latest changes from upstream:
@@ -148,5 +148,5 @@ project:
 
 **IMPORTANT**: By submitting a patch, you agree to allow the project owner to
 license your work under the same license as that used by the project, which you
-can see by clicking [here](https://github.com/WeTransfer/wetransfer/blob/master/LICENSE.txt).
+can see by clicking [here](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/LICENSE.txt).
 This provision also applies to the test files you include with the changed code as fixtures.

data/.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,25 @@
+---
+name: "\U0001F41B Bug report"
+about: "If something isn't working as expected \U0001F914"
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Input Code**
+- REPL or Repo link if applicable, otherwise a sample of code that can help us reproduce the bug.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment**
+- SDK version(s): [e.g. v0.2.0, v1.0.0-beta.34]
+- Ruby version: [e.g. 2.1.0, 2.4.3-patchXYZ, etc]
+- OS: [e.g. OSX 10.13.4, Windows 10]
+
+**Possible Solution**
+<!--- Only if you have suggestions on a fix for the bug -->
+
+**Additional context/Screenshots**
+Add any other context about the problem here. If applicable, add screenshots to help explain.

data/.github/ISSUE_TEMPLATE/Example_project.md

@@ -0,0 +1,20 @@
+---
+name: "\U0001F4AD Example project"
+about: "I have an idea for an example project (and may want to implement it \U0001F62C)!"
+
+---
+**What's the "elevator pitch" for the project?**
+A clear and concise - one sentence! - description of what the project is or could be.
+
+**Describe a potential solution**
+A clear and concise description of what could happen.
+
+**Describe resources you've considered**
+A clear and concise description of any resources you know of for making implementing your idea.
+
+**Additional context**
+Add any other context or screenshots about the project idea here.
+
+**Boilerplate - leave this here to explain the intent of these kinds of issues**
+Feel free to tackle this issue however you'd like - if you've got an idea for an example project, make the thing and let us know if we can help :-) - but this is also a good space for discussion and bouncing ideas off each other.
+

data/.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: "\U0001F680 Feature request"
+about: "I have a suggestion (and may want to implement it \U0001F642)!"
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+## Proposed changes
+
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+## Types of changes
+
+What types of changes does your code introduce to wetransfer_ruby_sdk?
+_Put an `x` in the boxes that apply_
+
+- [ ] Docs (missing or updated docs)
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Improvement / maintenance (removing technical debt, performance, tooling, etc...)
+
+## Checklist
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I have read the [CONTRIBUTING](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/.github/CONTRIBUTING.md) doc
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] Code changes are covered by unit tests.
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## Further comments
+
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

data/README.md

@@ -1,14 +1,16 @@
-# WeTransfer's Ruby SDK
+# WeTransfer Ruby SDK
 
-An open source Ruby SDK for the WeTransfer Open API
+An open source Ruby SDK for the WeTransfer Public API
 
-For your API key please visit our [developer portal](https://developers.wetransfer.com).
+For your API key and additional info please visit our [developer portal](https://developers.wetransfer.com).
+
+[![Build Status](https://travis-ci.com/WeTransfer/wetransfer_ruby_sdk.svg?token=fYsuJT8hjJt2hyWqaLsM&branch=master)](https://travis-ci.com/WeTransfer/wetransfer_ruby_sdk) [![Gem Version](https://badge.fury.io/rb/wetransfer.svg)](https://badge.fury.io/rb/wetransfer)
 
 ## Table of Contents
 
 1. [Installation](#installation)
 2. [Usage](#usage)
-3. [Configuration](#configuration)
+3. [Super simple transfers](#super-simple-transfers)
 4. [Development](#development)
 5. [Contributing](#contributing)
 6. [License](#license)
@@ -19,7 +21,7 @@ For your API key please visit our [developer portal](https://developers.wetransf
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'we_transfer_client'
+gem 'wetransfer'
 ```
 
 And then execute:
@@ -36,16 +38,30 @@ Or install it yourself as:
 
 You'll need to retrieve an API key from [our developer portal](https://developers.wetransfer.com).
 
-Be sure to not commit this key to Github! If you do though, no worries, you can always revoke & create a new key from within the portal. You will most likely want to pass this to the client setter using an environment variable.
+Be sure to not commit this key to Github! If you do though, no worries, you can always revoke & create a new key from within the portal.
+
+For configuring and storing secrets - like this API key - there are a variety of solutions. The smoothest here is creating a .env file:
+
+Now that you've got a wonderful WeTransfer API key, create a .env file in your project folder:
+
+    $ touch .env
 
-Now that you've got a wonderful WeTransfer API key, you can create a Client object like so:
+Check your `.gitignore` file and make sure it has `.env` listed!
+
+Now, open the file in your text editor and add this line:
+
+`WT_API_KEY=<your api key>` (without the <> brackets!)
+
+Great! Now you can go to your project file and create the client:
 
 ```ruby
 # In your project file:
+require 'we_transfer_client'
+
 @client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'))
 ```
 
-Now that you've got the client set up you can use the `create_transfer` to, well, create a transfer!
+Now that you've got the client set up you can use  `create_transfer` to, well, create a transfer!
 
 ```ruby
 transfer = @client.create_transfer(name: "My wonderful transfer", description: "I'm so excited to share this") do |upload|
@@ -60,19 +76,32 @@ transfer.shortened_url => "https://we.tl/SSBsb3ZlIHJ1Ynk="
 The upload will be performed at the end of the block.
 
 ## Development
+You'll need to retrieve an API key from [our developer portal](https://developers.wetransfer.com), and store it in a local `.env` file. As always, do not commit this file to github! :) 
 
-After forking and cloning down the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After forking and cloning down the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+```
+$ git clone <your fork>
+$ cd wetransfer_ruby_sdk
+$ bundle install
+```
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+To execute to ruby specs, run:
+
+```
+$ bundle exec rspec
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/wetransfer/wetransfer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/wetransfer/wetransfer_ruby_sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. More extensive contribution guidelines can be found [here](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/.github/CONTRIBUTING.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT) - the in-repo version of the license is [here](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the WetransferRubySdk project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wetransfer/wetransfer/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the WeTransfer Ruby SDK project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/WeTransfer/wetransfer_ruby_sdk/blob/master/.github/CODE_OF_CONDUCT.md).

data/examples/create_transfer.rb

@@ -3,7 +3,7 @@ require 'dotenv'
 Dotenv.load
 
 client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY')) # , logger: Logger.new($stderr))
-transfer = client.create_transfer(title: 'My amazing board', message: 'Hi there!') do |builder|
+transfer = client.create_transfer(name: 'My amazing transfer', description: 'Hi there!') do |builder|
   builder.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
   builder.add_file(name: 'amazing.txt', io: StringIO.new('This is unbelievable'))
   builder.add_file(name: 'huge.bin', io: File.open('/path/to/local/file.jpg', 'rb'))

data/lib/we_transfer_client.rb

@@ -83,11 +83,11 @@ class WeTransferClient
     @logger = logger
   end
 
-  def create_transfer(title:, message:)
+  def create_transfer(name:, description:)
     builder = TransferBuilder.new
     yield(builder)
     raise 'The transfer you have tried to create contains no items' if builder.items.empty?
-    future_transfer = FutureTransfer.new(name: title, description: message, items: builder.items)
+    future_transfer = FutureTransfer.new(name: name, description: description, items: builder.items)
     create_and_upload(future_transfer)
   end
 

data/lib/we_transfer_client/version.rb

@@ -1,3 +1,3 @@
 class WeTransferClient
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/integration_spec.rb

@@ -26,7 +26,7 @@ describe WeTransferClient do
 
   it 'is able to create a transfer start to finish, both with small and large files' do
     client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
-    transfer = client.create_transfer(title: 'My amazing board', message: 'Hi there!') do |builder|
+    transfer = client.create_transfer(name: 'My amazing board', description: 'Hi there!') do |builder|
       # Upload ourselves
       add_result = builder.add_file(name: File.basename(__FILE__), io: File.open(__FILE__, 'rb'))
       expect(add_result).to eq(true)
@@ -64,7 +64,7 @@ describe WeTransferClient do
   it 'refuses to create a transfer with no items' do
     client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
     expect {
-      client.create_transfer(title: 'My amazing board', message: 'Hi there!') do |builder|
+      client.create_transfer(name: 'My amazing board', description: 'Hi there!') do |builder|
         # ...do nothing
       end
     }.to raise_error(/no items/)
@@ -79,7 +79,7 @@ describe WeTransferClient do
     client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
     expect(client).not_to receive(:faraday) # Since we will not be doing any requests - we fail earlier
     expect {
-      client.create_transfer(title: 'My amazing board', message: 'Hi there!') do |builder|
+      client.create_transfer(name: 'My amazing board', description: 'Hi there!') do |builder|
         builder.add_file(name: 'broken', io: broken)
       end
     }.to raise_error(/failed somehow/)
@@ -90,7 +90,7 @@ describe WeTransferClient do
 
     client = WeTransferClient.new(api_key: ENV.fetch('WT_API_KEY'), logger: test_logger)
     expect {
-      client.create_transfer(title: 'My amazing board', message: 'Hi there!') do |builder|
+      client.create_transfer(name: 'My amazing board', description: 'Hi there!') do |builder|
         builder.add_file(name: 'broken', io: broken)
       end
     }.to raise_error(/has a size of 0/)

data/wetransfer.gemspec

@@ -27,6 +27,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.post_install_message = %q{
+    Warning: We have changed the syntax for the create_transfer method.
+    create_transfer(title:, message:) is now create_transfer(name:, description:)
+    Please update your usage accordingly. Thank you and our apologies for the disruption.
+  }
 
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'ks', '~> 0.0.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wetransfer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -146,12 +146,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE/Bug_report.md"
+- ".github/ISSUE_TEMPLATE/Example_project.md"
+- ".github/ISSUE_TEMPLATE/Feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -168,7 +172,10 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: "\n    Warning: We have changed the syntax for the create_transfer
+  method.\n    create_transfer(title:, message:) is now create_transfer(name:, description:)\n
+  \   Please update your usage accordingly. Thank you and our apologies for the disruption.\n
+  \ "
 rdoc_options: []
 require_paths:
 - lib