cloudxls 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fab7cbcc052f7807d5d721580dedaa82d7cb64e
-  data.tar.gz: 9f6c7a7e75036f8d7d79ddbdebac9e03f6178b7a
+  metadata.gz: d7e1697a99d75266681864389273a9aff73f0db3
+  data.tar.gz: 667f2e5d6d326f687626081345482560e012330c
 SHA512:
-  metadata.gz: 9ce70375e14270a59099be0f95b57eb6f0bd38938362d52d2867e2ad2c7e9f84e1a1791d8d50c9de63a3b1d8de59d894e53aa6537e2a935e398198b1911e5599
-  data.tar.gz: 15247999df556ae0b684e40676cb46487c089f63f4ff150f665ea32521d16e289cd4f554e431fbad338dfeaba2fab4e6b75bbd23478dd1c7d74e99fa5962f333
+  metadata.gz: 48fabb7292c78214523a1b06cecb227833799da0cc4abec208f04472d5c4ec1777fa0d0281268762cc291fab3c1b6cde9f6a3378cd4c1d14696b87a5aaa3c36b
+  data.tar.gz: 61bffb4c9848e56a758e87a3eca36ba1da357a6c9b8f844ac3e8044baabfb34e5c2894165a8cef56c7d223a72446ab66967ee29d8bda69b711acdaf79d59f440

data/README.md

@@ -4,11 +4,11 @@
 
 Or in your Gemfile
 
-    gem 'cloudxls', '~> 2.0.0-beta'
+    gem 'cloudxls', '~> 2.0.2'
 
 # Documentation
 
-Additional documentation: [https://docs.cloudxls.com](docs.cloudxls.com)
+Additional documentation: [https://docs.cloudxls.com](https://docs.cloudxls.com)
 
 # Quick Start Guide
 
@@ -29,10 +29,10 @@ to the sandbox test API.
 
 ## Read-API
 
-Send an xls or xlsx file using the `Cloudxls#read` method. `#to_h` will start the request and parse the json into a ruby hash.
+Send an xls or xlsx file using the `Cloudxls#read` method. `#as_json` will start the request and `#to_h` parses the json into a ruby hash.
 
 ```ruby
-data = Cloudxls.read(file: File.new("/path/to/my-excel.xls")).to_h
+data = Cloudxls.read(file: File.new("/path/to/my-excel.xls")).as_json.to_h
 ```
 
 Output

data/lib/cloudxls/version.rb

@@ -1,3 +1,3 @@
 class Cloudxls
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/lib/cloudxls.rb

@@ -3,30 +3,43 @@ require 'json'
 require 'net/http'
 require 'net/http/post/multipart'
 
+require 'cloudxls/version'
 
 class Cloudxls
+
   class ApiError < Exception
   end
 
   @sandbox_base = "sandbox.cloudxls.com"
   @api_version  = "v2".freeze
+  @api_key  = nil
+  @api_base = nil
 
   class << self
-    attr_accessor :api_key,
-                  :api_version,
-                  :api_base,
+    attr_writer :api_key,
+                :api_base
+
+    attr_accessor :api_version,
                   :sandbox_base,
                   :port
 
     def client_options
       {
-        api_key: self.api_key || ENV.fetch("CLOUDXLS_API_KEY", nil),
-        api_version: self.api_version,
-        api_base: self.api_base || ENV.fetch("CLOUDXLS_API_BASE", "api.cloudxls.com"),
+        api_key: api_key,
+        api_version: api_version,
+        api_base: api_base,
         port: 443
       }
     end
 
+    def api_key
+      @api_key ||= ENV["CLOUDXLS_API_KEY"]
+    end
+
+    def api_base
+      @api_base ||= ENV.fetch("CLOUDXLS_API_BASE", "api.cloudxls.com")
+    end
+
     # Initializes a Write request
     #
     # @param [Hash] params request parameters as
@@ -87,6 +100,9 @@ class Cloudxls
       "/#{client_options[:api_version]}/#{path}"
     end
 
+    def user_agent
+      "cloudxls-ruby #{VERSION}"
+    end
 
     # Starts request and yields response to block
     #
@@ -96,9 +112,7 @@ class Cloudxls
       raise "#{self.class.name} already executed" if @finished
 
       start do |http|
-        request = Net::HTTP::Post::Multipart.new(self.path, @post_data)
-        request.basic_auth api_key, ""
-        request['User-Agent'] = "cloudxls-ruby #{VERSION}"
+        request = build_request
 
         if block_given?
           http.request(request) do |response|
@@ -115,6 +129,14 @@ class Cloudxls
       @finished = true
       self
     end
+
+
+    def build_request
+      request = Net::HTTP::Post::Multipart.new(self.path, @post_data)
+      request.basic_auth api_key, ""
+      request['User-Agent'] = user_agent
+      request
+    end
   end
 
   module BaseResponse

data/test/cloudxls_test.rb

@@ -1,18 +1,18 @@
 require 'test_helper'
 
 class CloudxlsTest < Minitest::Test
-  def test_defaults
-    Cloudxls.api_key = "test_foo"
-    file = Cloudxls.write(csv: "hello,world").as_xls.save_as("/tmp/foo.xls")
-    hash = Cloudxls.read(excel: File.new(file.path)).to_h
-    assert_equal ["hello", "world"], hash.first["rows"][0]
+  def setup
+    Cloudxls.api_key = nil
   end
 
-  def test_defaults
-    Cloudxls.api_key = "test_foo"
-    file = Cloudxls.write(csv: File.new("test/test.csv")).as_xls.save_as("/tmp/foo.xls")
-    hash = Cloudxls.read(excel: File.new(file.path)).as_json.to_h
-    assert_equal ["hello", "world"], hash.first["rows"][0]
+  def test_env_variables
+    ENV["CLOUDXLS_API_KEY"] = "env-var"
+    assert_equal "env-var", Cloudxls.api_key
+
+    Cloudxls.api_key = "custom"
+    assert_equal "custom", Cloudxls.api_key
+  ensure
+    ENV.delete("CLOUDXLS_API_KEY")
   end
 
   def test_accessors
@@ -26,4 +26,24 @@ class CloudxlsTest < Minitest::Test
   def test_test_api_keys
     Cloudxls::WriteRequest.new(api_key: "test_foobar")
   end
+
+  def test_version
+    assert Cloudxls::VERSION.start_with?("2.")
+  end
+
+  def test_user_agent
+    assert Cloudxls::WriteRequest.new.user_agent.start_with?("cloudxls-ruby 2.")
+  end
+
+  def test_path_to
+    assert_equal "/v2/", Cloudxls::WriteRequest.new.path_to("")
+    assert_equal "/v2/hello-world", Cloudxls::WriteRequest.new.path_to("hello-world")
+    assert_equal "/v2.1/", Cloudxls::WriteRequest.new(api_version: "v2.1").path_to("")
+  end
+
+  def test_build_request
+    req = Cloudxls::WriteRequest.new(api_key: "your-api-key").build_request
+    refute_nil req["User-Agent"]
+  end
+
 end

data/test/integration_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+# Tests with sandbox. requires a valid test key
+#
+class IntegrationTest < Minitest::Test
+  def setup
+    Cloudxls.api_key = nil
+  end
+
+  def test_defaults_text
+    skip unless ENV["CLOUDXLS_API_KEY"]
+
+    file = Cloudxls.write(csv: "hello,world").as_xls.save_as("/tmp/foo.xls")
+    hash = Cloudxls.read(excel: File.new(file.path)).as_json.to_h
+    assert_equal ["hello", "world"], hash.first["rows"][0]
+  end
+
+  def test_defaults_file
+    skip unless ENV["CLOUDXLS_API_KEY"]
+
+    file = Cloudxls.write(csv: File.new("test/test.csv")).as_xls.save_as("/tmp/foo.xls")
+    hash = Cloudxls.read(excel: File.new(file.path)).as_json.to_h
+    assert_equal ["hello", "world"], hash.first["rows"][0]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Sebastian Burkhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -65,18 +65,10 @@ files:
 - README.md
 - Rakefile
 - cloudxls.gemspec
-- examples/async.rb
-- examples/data.csv
-- examples/files.rb
-- examples/full.rb
-- examples/inline.rb
-- examples/multi_sheet.rb
-- examples/template.xls
-- examples/template.xlsx
-- examples/templates.rb
 - lib/cloudxls.rb
 - lib/cloudxls/version.rb
 - test/cloudxls_test.rb
+- test/integration_test.rb
 - test/test.csv
 - test/test_helper.rb
 homepage: https://cloudxls.com
@@ -104,5 +96,6 @@ specification_version: 4
 summary: Ruby wrapper to read and write Excel through the cloudxls API.
 test_files:
 - test/cloudxls_test.rb
+- test/integration_test.rb
 - test/test.csv
 - test/test_helper.rb

data/examples/async.rb

@@ -1,24 +0,0 @@
-# ruby examples/async.rb
-#
-# Use this in a Rails/Sinatra action to redirect user
-# directly to the file download (expires after 10min).
-
-require_relative '../lib/cloudxls'
-
-unless ENV["CLOUDXLS_API_KEY"]
-  puts "--- WARNING ---"
-  puts "Please add environment variable CLOUDXLS_API_KEY"
-  puts "export CLOUDXLS_API_KEY=YOUR_API_KEY"
-  puts "---------------"
-  exit
-end
-
-CloudXLS.api_key = ENV["CLOUDXLS_API_KEY"];
-
-resp = CloudXLS.async({
-  data:  { text: "Greeting,Greetee\nHello,World" },
-  sheet: { name: 'Hello World' },
-  doc:   { filename: 'hello-world' }
-})
-
-puts "Download file from: #{resp.url}"

data/examples/data.csv

@@ -1,2 +0,0 @@
-greeting,greetee
-hello,world

data/examples/files.rb

@@ -1,19 +0,0 @@
-# ruby examples/files.rb
-
-require_relative '../lib/cloudxls'
-
-unless ENV["CLOUDXLS_API_KEY"]
-  puts "--- WARNING ---"
-  puts "Please add environment variable CLOUDXLS_API_KEY"
-  puts "export CLOUDXLS_API_KEY=YOUR_API_KEY"
-  puts "---------------"
-  exit
-end
-
-CloudXLS.api_key = ENV["CLOUDXLS_API_KEY"];
-
-resp = CloudXLS.inline({
-  data:  { file: File.new("./examples/data.csv") }
-})
-
-File.open("out-file.xls", "wb") { |f| f.write resp }

data/examples/full.rb

@@ -1,42 +0,0 @@
-# ruby examples/full.rb
-#
-# With all the options
-
-require_relative '../lib/cloudxls'
-
-unless ENV["CLOUDXLS_API_KEY"]
-  puts "--- WARNING ---"
-  puts "Please add environment variable CLOUDXLS_API_KEY"
-  puts "export CLOUDXLS_API_KEY=YOUR_API_KEY"
-  puts "---------------"
-  exit
-end
-
-CloudXLS.api_key = ENV["CLOUDXLS_API_KEY"];
-
-resp = CloudXLS.inline({
-  sheets: {
-    "Sheet1" => {
-      data: {
-        text: "Greeting;Greetee;Date\nHello;World;2011-01-02",
-        separator: ";",
-        date_format: "YYYY-MM-DD", # is default
-        encoding: "UTF-8", # is default
-      },
-      sheet: {
-        cell: "C3",    # define cell
-        filters: true, # adds filter boxes
-        auto_size_columns: true, # adjust column width (experimental)
-        cell_formats: "@,@,dd-mmm-yyyy"
-      }
-    },
-    "Sheet3!B2" => {data: {file: File.new("./examples/data.csv") }},
-  },
-  doc: {
-    filename: "output",
-    template: File.new("./examples/template.xls")
-  }
-})
-
-File.open("out-full.xls", "wb") { |f| f.write resp }
-puts "File saved: ./out-full.xls"

data/examples/inline.rb

@@ -1,25 +0,0 @@
-# ruby examples/inline.rb
-#
-# Use to directly download file.
-
-require_relative '../lib/cloudxls'
-
-unless ENV["CLOUDXLS_API_KEY"]
-  puts "--- WARNING ---"
-  puts "Please add environment variable CLOUDXLS_API_KEY"
-  puts "export CLOUDXLS_API_KEY=YOUR_API_KEY"
-  puts "---------------"
-  exit
-end
-
-CloudXLS.api_key = ENV["CLOUDXLS_API_KEY"];
-
-resp = CloudXLS.inline({
-  data:  { text: "Greeting,Greetee\nHello,World" },
-  sheet: { name: 'Hello World' },
-  doc:   { filename: 'hello-world' }
-})
-
-
-File.open("out.xls", "wb") { |f| f.write resp }
-puts "File saved"

data/examples/multi_sheet.rb

@@ -1,28 +0,0 @@
-# ruby examples/multi_sheet.rb
-
-require_relative '../lib/cloudxls'
-
-unless ENV["CLOUDXLS_API_KEY"]
-  puts "--- WARNING ---"
-  puts "Please add environment variable CLOUDXLS_API_KEY"
-  puts "export CLOUDXLS_API_KEY=YOUR_API_KEY"
-  puts "---------------"
-  exit
-end
-
-CloudXLS.api_key = ENV["CLOUDXLS_API_KEY"];
-
-resp = CloudXLS.inline({
-  sheets: {
-    "Sheet1" => {
-      data: {text: "Greeting,Greetee\nHello,World" },
-      sheet: {cell: "C3" }
-    },
-    "Sheet2!D4" => {data: {text: "Greeting,Greetee\nHello,World" }},
-    "Sheet3!B2" => {data: {file: File.new("./examples/data.csv") }},
-  }
-})
-
-
-File.open("out-multi_sheet.xls", "wb") { |f| f.write resp }
-puts "File saved"

data/examples/templates.rb

@@ -1,34 +0,0 @@
-# ruby examples/templates.rb
-#
-# Merge data into excel files.
-
-require_relative '../lib/cloudxls'
-
-unless ENV["CLOUDXLS_API_KEY"]
-  puts "--- WARNING ---"
-  puts "Please add environment variable CLOUDXLS_API_KEY"
-  puts "export CLOUDXLS_API_KEY=YOUR_API_KEY"
-  puts "---------------"
-  exit
-end
-
-CloudXLS.api_key = ENV["CLOUDXLS_API_KEY"];
-
-resp = CloudXLS.inline({
-  data:  { text: "Greeting,Greetee\nHello,World" },
-  sheet: { name: 'Hello World' },
-  doc:   { template: File.new("./examples/template.xls") }
-})
-
-
-File.open("out-template.xls", "wb") { |f| f.write resp }
-puts "File saved: ./out-template.xls"
-
-resp = CloudXLS.inline({
-  data:  { text: "Greeting,Greetee\nHello,World" },
-  sheet: { name: 'Hello World' },
-  doc:   { template: File.new("./examples/template.xlsx") }
-})
-
-File.open("out-template.xlsx", "wb") { |f| f.write resp }
-puts "File saved: ./out-template.xlsx"