Rename communication module

Start documenting the behavior better

Author: arnoFleming

.travis.yml

@@ -12,6 +12,5 @@ matrix:
   allow_failures:
     - rvm: jruby-9.0
 script:
-  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then bundle exec rspec --exclude-pattern "spec/integration_spec.rb"; fi'
-  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then bundle exec rspec; fi'
+  - RUBYOPT="--enable-frozen-string-literal" bundle exec rspec
   - bundle exec rubocop -c .rubocop.yml --force-exclusion

README.md

@@ -24,7 +24,7 @@ For your API key and additional info please visit our [developer portal](https:/
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'wetransfer', version: '0.9.0.beta2'
+gem 'wetransfer', version: '0.9.0.beta3'
 ```
 
 And then execute:
@@ -57,7 +57,7 @@ Open the file in your text editor and add this line:
 
     WT_API_KEY=<your api key>
 
-Make sure to replace `<your api key>` by your actual api key. Don't include the pointy brackets!
+Make sure to replace `<your api key>` with your actual api key. Don't include the pointy brackets!
 
 Great! Now you can go to your project file and use the client.
 
@@ -66,8 +66,8 @@ Great! Now you can go to your project file and use the client.
 A transfer is a collection of files that can be created once, and downloaded until it expires. Once a transfer is ready for sharing, it is closed for modifications.
 
 ```ruby
-# In your project file:
-require 'we_transfer_client'
+# In your proje ct file:
+require 'we_transfer'
 
 client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
 ```
@@ -97,7 +97,7 @@ Boards need a WeTransfer Client to be present, just like transfers.
 
 ```ruby
 # In your project file:
-require 'we_transfer_client'
+require 'we_transfer'
 
 client = WeTransfer::Client.new(api_key: ENV.fetch('WT_API_KEY'))
 ```
@@ -106,7 +106,6 @@ After you create your client, you can
 
 ### Create a board and upload items
 
-
 ```ruby
 board = client.create_board(name: 'Meow', description: 'On Cats') do |items|
   items.add_file(name: 'big file.jpg', io: File.open('/path/to/huge_file.jpg', 'rb')items.add_file_at(path: '/path/to/another/file.txt')
@@ -150,12 +149,12 @@ Hooray!
 
 ## Contributing
 
-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).
+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 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 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).
+Everyone interacting in the WeTransfer Ruby SDK project’s code bases, 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).

bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'we_transfer_client'
+require 'we_transfer'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

examples/create_collection.rb

@@ -1,4 +1,4 @@
-require_relative 'we_transfer_client'
+require_relative 'we_transfer'
 require 'dotenv'
 Dotenv.load
 

examples/create_transfer.rb

@@ -1,4 +1,4 @@
-require_relative 'we_transfer_client'
+require_relative 'we_transfer'
 require 'dotenv'
 Dotenv.load
 

lib/we_transfer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'logger'
+require 'json'
+require 'ks'
+
+%w[communication_helper client transfer mini_io we_transfer_file remote_file version].each do |file|
+  require_relative "we_transfer/#{file}"
+end
+
+module WeTransfer; end

lib/we_transfer_client.rb renamed to lib/we_transfer/client.rb

@@ -1,18 +1,9 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'logger'
-require 'json'
-require 'ks'
-
-%w[communication_helper transfer mini_io we_transfer_file remote_file version].each do |file|
-  require_relative "we_transfer/#{file}"
-end
-
 module WeTransfer
   class Client
     class Error < StandardError; end
-    include CommunicationHelper
+    include Communication
 
     NullLogger = Logger.new(nil)
 
@@ -25,9 +16,9 @@ class Error < StandardError; end
     #
     # @return [WeTransfer::Client]
     def initialize(api_key:, logger: NullLogger)
-      CommunicationHelper.reset_authentication!
-      CommunicationHelper.api_key = api_key
-      CommunicationHelper.logger = logger
+      Communication.reset_authentication!
+      Communication.api_key = api_key
+      Communication.logger = logger
     end
 
     def create_transfer(**args, &block)
@@ -38,6 +29,12 @@ def create_transfer(**args, &block)
       self
     end
 
+    def create_transfer_and_upload_files(message:, &block)
+      transfer = WeTransfer::Transfer.new(args)
+      transfer.persist(&block)
+
+    end
+
     def find_transfer(transfer_id)
       @transfer = WeTransfer::Transfer.find(transfer_id)
     end

lib/we_transfer/communication_helper.rb renamed to lib/we_transfer/communication.rb

@@ -1,7 +1,7 @@
 module WeTransfer
   class CommunicationError < StandardError; end
 
-  module CommunicationHelper
+  module Communication
     extend Forwardable
 
     API_URL_BASE = "https://dev.wetransfer.com"

lib/we_transfer/transfer.rb

@@ -10,7 +10,7 @@ class FileMismatchError < StandardError; end
 
     class << self
       extend Forwardable
-      def_delegator CommunicationHelper, :find_transfer, :find
+      def_delegator Communication, :find_transfer, :find
     end
 
     def self.create(message:, &block)
@@ -29,7 +29,7 @@ def persist
       yield(self) if block_given?
       raise NoFilesAddedError if @unique_file_names.empty?
 
-      CommunicationHelper.persist_transfer(self)
+      Communication.persist_transfer(self)
     end
 
     # Add one or more files to a transfer, so a transfer can be created over the
@@ -60,22 +60,22 @@ def upload_file(name:, io: nil)
         chunk_contents = StringIO.new(put_io.read(file.multipart.chunk_size))
         chunk_contents.rewind
 
-        CommunicationHelper.upload_chunk(put_url, chunk_contents)
+        Communication.upload_chunk(put_url, chunk_contents)
       end
     end
 
     def upload_url_for_chunk(name:, chunk:)
       file_id = find_file_by_name(name).id
-      CommunicationHelper.upload_url_for_chunk(id, file_id, chunk)
+      Communication.upload_url_for_chunk(id, file_id, chunk)
     end
 
     def complete_file(name:)
       file = find_file_by_name(name)
-      CommunicationHelper.complete_file(id, file.id, file.multipart.chunks)
+      Communication.complete_file(id, file.id, file.multipart.chunks)
     end
 
     def finalize
-      CommunicationHelper.finalize_transfer(self)
+      Communication.finalize_transfer(self)
     end
 
     def as_request_params

spec/spec_helper.rb

@@ -5,7 +5,7 @@
   add_filter '/spec/'
 end
 
-require 'we_transfer_client'
+require 'we_transfer'
 require 'pry'
 require 'rspec'
 require 'bundler'