cloudxls 2.0.0.pre.beta → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e911a06e80702fbc54262bcd3cbc18a062be0a80
-  data.tar.gz: ea552bd27ba131071ffc9208917e4d9eed337a7c
+  metadata.gz: fc4d555e2c11a064de173550ec112a8515b16604
+  data.tar.gz: 78a87ac79d22710035968edaa8b662dc90d18c33
 SHA512:
-  metadata.gz: 8190f8b90d96ef9cf5bfc76f2f843119f8ba9afc6557b59f660eaae3bcff641f068f93a7754ffe5dce526ff6bac1eb0dd67d2e752f5de18478406fd6b13ce8d9
-  data.tar.gz: 441c7f7eed10b3e53683f5c37e38ce2450083e571f56719a28365d445a2177a1b87125a0e5d49bf7580951cfe49867235d2c1b18b52f37e7d8a6bebed54b3c9f
+  metadata.gz: 9a444d889a3a7243894721ee13f3267403cd7b596f5298713d31234ee3737172b94848d89fba0cdc2a1be43d69804469816423374f624c90224bb1d7d91829de
+  data.tar.gz: c4045675c18f8ed7eb7bc8430c41de16b134f17c4276e273b619ad84a5d9eaead6376e4189b0da68d8403cbd234fa9e34a527fb054b6d6baba5911fc2946a020

data/lib/cloudxls.rb

@@ -29,12 +29,22 @@ class Cloudxls
       }
     end
 
-    def write(params = nil, client_options = nil)
-      Write.new(client_options).add_data(params)
+    # Initializes a Write request
+    #
+    # @param [Hash] params request parameters as
+    # @return [WriteRequest] write request object
+    #
+    def write(params = nil)
+      WriteRequest.new(client_options).add_data(params)
     end
 
-    def read(params = nil, client_options = nil)
-      Read.new(client_options).add_data(params)
+    # Initializes a Read request
+    #
+    # @param [Hash] params request parameters as
+    # @return [WriteRequest] write request object
+    #
+    def read(params = nil)
+      ReadRequest.new(client_options).add_data(params)
     end
   end
 
@@ -54,6 +64,10 @@ class Cloudxls
       key
     end
 
+    # Is Api Key for testing/sandbox only?
+    #
+    # @return [Boolean] write request object
+    #
     def test_key?
       api_key.to_s.downcase.start_with?("test")
     end
@@ -66,6 +80,8 @@ class Cloudxls
       end
     end
 
+    # Internal. Starts the request.
+    #
     def start(&block)
       Net::HTTP.start(api_base, client_options[:port], use_ssl: true, &block)
     end
@@ -74,10 +90,17 @@ class Cloudxls
       "/#{client_options[:api_version]}/#{path}"
     end
 
+    # Alias for #each
+    #
     def data
       each
     end
 
+    # Writes to IO object
+    #
+    # @params [IO, #write] io
+    # @returns [IO]
+    #
     def write_to(io)
       each do |chunk|
         io.write chunk
@@ -87,10 +110,19 @@ class Cloudxls
       io.close
     end
 
+    # Write response to file
+    #
+    # @params [String] path
+    # @returns [File]
+    #
     def save_as(path)
       write_to File.open(path, 'wb')
     end
 
+    # Starts request and yields response to block
+    #
+    # @params [String] path
+    #
     def each(&block)
       raise "#{self.class.name} already executed" if @finished
 
@@ -116,7 +148,7 @@ class Cloudxls
     end
   end
 
-  class Read
+  class ReadRequest
     include BaseRequest
 
     # post_data is an array of key,value arrays. Reason:
@@ -126,6 +158,7 @@ class Cloudxls
     # Example: [["separator", ","], ["csv", "hello,world"]]
     attr_reader :post_data
     attr_reader :client_options
+    attr_accessor :file_format
 
     DATA_PARAMETERS = %w[excel file]
 
@@ -140,6 +173,10 @@ class Cloudxls
       self
     end
 
+    # Response as string
+    #
+    # @return [String]
+    #
     def response_body
       # TODO: optimize
       str = ""
@@ -149,6 +186,28 @@ class Cloudxls
       str
     end
 
+    # Set request to JSON
+    #
+    # @returns [require] returns self
+    #
+    def as_json
+      self.file_format = "json"
+      self
+    end
+
+    # Set request to CSV
+    #
+    # @returns [WriteRequest] returns self
+    #
+    def as_csv
+      self.file_format = "csv"
+      self
+    end
+
+    # Response as Hash (used with json)
+    #
+    # @return [String]
+    #
     def to_h
       JSON.load(response_body)
     end
@@ -156,11 +215,11 @@ class Cloudxls
   protected
 
     def path
-      path_to("read.json")
+      path_to("read.#{file_format || "json"}")
     end
   end
 
-  class Write
+  class WriteRequest
     include BaseRequest
     # post_data is an array of key,value arrays. Reason:
     # - A key can appear multiple times (for multiple sheets)
@@ -174,11 +233,19 @@ class Cloudxls
 
     DATA_PARAMETERS = %w[data data_url csv csv_url json json_url]
 
+    # Add another configuration block, consisting of sheet configuration and data element.
+    #
+    # @params [Hash] params
+    # @returns [WriteRequest] returns self
+    #
     def add_data(params = nil)
       data_params = []
       params.each do |key, value|
         key = key.to_s
         if DATA_PARAMETERS.include?(key)
+          if value.is_a?(File)
+            value = UploadIO.new(value, "text/csv", "data")
+          end
           data_params << [key, value]
         else
           @post_data << [key, value]
@@ -188,18 +255,31 @@ class Cloudxls
       self
     end
 
+    # Set request to XLS
+    #
+    # @returns [WriteRequest] returns self
+    #
     def as_xls
       self.file_format = "xls"
       self
     end
 
+    # Set request to XLSX
+    #
+    # @returns [WriteRequest] returns self
+    #
     def as_xlsx
       self.file_format = "xlsx"
       self
     end
 
+    # Sets request to XLSX
+    #
+    # @returns [WriteRequest] returns self
+    #
     def append_to(target_file)
-      @post_data = [["target_file", target_file]] + @post_data
+      io = UploadIO.new(target_file, "application/octet-stream", "target-file")
+      @post_data = [["target_file", io]] + @post_data
       self
     end
 

data/lib/cloudxls/version.rb

@@ -1,3 +1,3 @@
 class Cloudxls
-  VERSION = '2.0.0-beta'
+  VERSION = '2.0.0'
 end

data/test/cloudxls_test.rb

@@ -8,15 +8,22 @@ class CloudxlsTest < Minitest::Test
     assert_equal ["hello", "world"], hash.first["rows"][0]
   end
 
+  def test_defaults
+    Cloudxls.api_key = "test_foo"
+    file = Cloudxls.write(csv: File.new("test/test.csv")).save_as("/tmp/foo.xls")
+    hash = Cloudxls.read(excel: File.new(file.path)).to_h
+    assert_equal ["hello", "world"], hash.first["rows"][0]
+  end
+
   def test_accessors
     Cloudxls.api_key = "test_foo"
     assert_equal "test_foo", Cloudxls.api_key
 
     Cloudxls.api_base = "sandbox.cloudxls.com"
-    assert_equal "sandbox.cloudxls.com", Cloudxls.api_host
+    assert_equal "sandbox.cloudxls.com", Cloudxls.api_base
   end
 
   def test_test_api_keys
-    Cloudxls::Write.new(api_key: "test_foobar")
+    Cloudxls::WriteRequest.new(api_key: "test_foobar")
   end
 end

data/test/test.csv

@@ -0,0 +1 @@
+hello,world

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta
+  version: 2.0.0
 platform: ruby
 authors:
 - Sebastian Burkhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -77,6 +77,7 @@ files:
 - lib/cloudxls.rb
 - lib/cloudxls/version.rb
 - test/cloudxls_test.rb
+- test/test.csv
 - test/test_helper.rb
 homepage: https://cloudxls.com
 licenses: []
@@ -92,9 +93,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
@@ -103,4 +104,5 @@ specification_version: 4
 summary: Ruby wrapper to read and write Excel through the cloudxls API.
 test_files:
 - test/cloudxls_test.rb
+- test/test.csv
 - test/test_helper.rb