cloudxls 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc4d555e2c11a064de173550ec112a8515b16604
-  data.tar.gz: 78a87ac79d22710035968edaa8b662dc90d18c33
+  metadata.gz: 1fab7cbcc052f7807d5d721580dedaa82d7cb64e
+  data.tar.gz: 9f6c7a7e75036f8d7d79ddbdebac9e03f6178b7a
 SHA512:
-  metadata.gz: 9a444d889a3a7243894721ee13f3267403cd7b596f5298713d31234ee3737172b94848d89fba0cdc2a1be43d69804469816423374f624c90224bb1d7d91829de
-  data.tar.gz: c4045675c18f8ed7eb7bc8430c41de16b134f17c4276e273b619ad84a5d9eaead6376e4189b0da68d8403cbd234fa9e34a527fb054b6d6baba5911fc2946a020
+  metadata.gz: 9ce70375e14270a59099be0f95b57eb6f0bd38938362d52d2867e2ad2c7e9f84e1a1791d8d50c9de63a3b1d8de59d894e53aa6537e2a935e398198b1911e5599
+  data.tar.gz: 15247999df556ae0b684e40676cb46487c089f63f4ff150f665ea32521d16e289cd4f554e431fbad338dfeaba2fab4e6b75bbd23478dd1c7d74e99fa5962f333

data/README.md

@@ -52,7 +52,7 @@ Output
 From a remote url
 
 ```ruby
-data = Cloudxls.read(file_url: "http://example.org/data.xls").to_h
+data = Cloudxls.read(file_url: "http://example.org/data.xls").as_json.to_h
 ```
 
 Save json to a file
@@ -66,7 +66,7 @@ Or access the response_stream directly
 
 ```ruby
 io = File.new("output.json", "w")
-Cloudxls.read(file: File.new("/path/to/my-excel.xls")).each do |chunk|
+Cloudxls.read(file: File.new("/path/to/my-excel.xls")).as_csv.each do |chunk|
   io.write chunk
 end
 io.close
@@ -80,7 +80,9 @@ Write a xls file with a single sheet.
 csv_string = "hello,world\nfoo,bar"
 
 Cloudxls.write(csv: csv_string)
+  .as_xls
   .save_as("/tmp/hello-world.xls")
+
 ```
 
 Write xlsx:
@@ -99,7 +101,8 @@ req = Cloudxls.write(
   offset: "B2",
   sheet_name: "Data"
 )
-req.save_as("/tmp/hello-world.xls")
+xls_response = req.as_xls
+xls_response.save_as("/tmp/hello-world.xls")
 ```
 
 Multiple sheets:
@@ -108,6 +111,7 @@ Multiple sheets:
 Cloudxls.write(csv: csv_string)
   .add_data(csv: "more,data")
   .add_data(csv: "more,data", sheet_name: "foobar")
+  .as_xls
   .save_as("/tmp/hello-world.xls")
 ```
 
@@ -116,6 +120,7 @@ Append data to a excel file (xls or xlsx)
 ```ruby
 Cloudxls.write(csv: csv_string)
   .target_file(File.new("/path/to/my-file.xls"))
+  .as_xls
   .save_as("/tmp/hello-world.xls")
 ```
 
@@ -126,9 +131,16 @@ Assign the result of a `#write` or `#read` call to the `response_body`.
 
 ```ruby
 def index
-  headers["Content-Type"] = "application/vnd.ms-excel"
-  headers["Content-disposition"] = "attachment; filename=users.xls"
+  csv_data = "hello,world"
+
+  headers["Content-Type"] = Mime::Type.lookup_by_extension(params[:format])
+  headers["Content-disposition"] = "attachment; filename=data.#{params[:format]}"
+
+  respond_to do |format|
 
-  self.response_body = Cloudxls.write(csv: User.all.to_csv)
+    format.csv  { self.response_body = csv_data }
+    format.xls  { self.response_body = Cloudxls.write(csv: csv_data).as_xls }
+    format.xlsx { self.response_body = Cloudxls.write(csv: csv_data).as_xlsx }
+  end
 end
 ```

data/lib/cloudxls/version.rb

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

data/lib/cloudxls.rb

@@ -8,8 +8,6 @@ class Cloudxls
   class ApiError < Exception
   end
 
-  @api_key      = ENV.fetch("CLOUDXLS_API_KEY", nil)
-  @api_base     = ENV.fetch("CLOUDXLS_API_BASE", "api.cloudxls.com")
   @sandbox_base = "sandbox.cloudxls.com"
   @api_version  = "v2".freeze
 
@@ -22,9 +20,9 @@ class Cloudxls
 
     def client_options
       {
-        api_key: self.api_key,
+        api_key: self.api_key || ENV.fetch("CLOUDXLS_API_KEY", nil),
         api_version: self.api_version,
-        api_base: self.api_base,
+        api_base: self.api_base || ENV.fetch("CLOUDXLS_API_BASE", "api.cloudxls.com"),
         port: 443
       }
     end
@@ -35,7 +33,7 @@ class Cloudxls
     # @return [WriteRequest] write request object
     #
     def write(params = nil)
-      WriteRequest.new(client_options).add_data(params)
+      WriteRequest.new(self.client_options).add_data(params)
     end
 
     # Initializes a Read request
@@ -44,14 +42,13 @@ class Cloudxls
     # @return [WriteRequest] write request object
     #
     def read(params = nil)
-      ReadRequest.new(client_options).add_data(params)
+      ReadRequest.new(self.client_options).add_data(params)
     end
   end
 
   module BaseRequest
     def initialize(client_options = nil)
       @post_data = []
-
       @finished  = false
       @client_options = client_options || Cloudxls.client_options
     end
@@ -90,10 +87,54 @@ class Cloudxls
       "/#{client_options[:api_version]}/#{path}"
     end
 
-    # Alias for #each
+
+    # Starts request and yields response to block
+    #
+    # @params [String] path
+    #
+    def each(&block)
+      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}"
+
+        if block_given?
+          http.request(request) do |response|
+            if Net::HTTPSuccess === response
+              response.read_body(&block)
+            else
+              raise ApiError.new("#{response.code} #{response.class.name.to_s}: #{response.body}")
+            end
+          end
+        else
+          http.request(request)
+        end
+      end
+      @finished = true
+      self
+    end
+  end
+
+  module BaseResponse
+    # Response as string
     #
-    def data
-      each
+    # @return [String]
+    #
+    def response_body
+      # TODO: optimize
+      str = ""
+      each do |chunk|
+        str << chunk
+      end
+      str
+    end
+
+    # Response body. Required to make Rails send_data work out of the box.
+    #
+    def to_s
+      response_body
     end
 
     # Writes to IO object
@@ -119,32 +160,24 @@ class Cloudxls
       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
+      @request.each(&block)
+    end
+  end
 
-      start do |http|
-        request = Net::HTTP::Post::Multipart.new(self.path, @post_data)
-        request.basic_auth api_key, ""
-        request['User-Agent'] = "cloudxls-ruby #{Cloudxls::VERSION}"
+  class ReadResponse
+    include BaseResponse
 
-        if block_given?
-          http.request(request) do |response|
-            if Net::HTTPSuccess === response
-              response.read_body(&block)
-            else
-              raise ApiError.new("#{response.code} #{response.class.name.to_s}: #{response.body}")
-            end
-          end
-        else
-          http.request(request)
-        end
-      end
-      @finished = true
-      self
+    def initialize(req)
+      @request = req
+    end
+
+    # Response as Hash (used with json)
+    #
+    # @return [String]
+    #
+    def to_h
+      JSON.load(response_body)
     end
   end
 
@@ -173,43 +206,22 @@ class Cloudxls
       self
     end
 
-    # Response as string
-    #
-    # @return [String]
-    #
-    def response_body
-      # TODO: optimize
-      str = ""
-      each do |chunk|
-        str << chunk
-      end
-      str
-    end
-
     # Set request to JSON
     #
-    # @returns [require] returns self
+    # @returns [ReadResponse] read response
     #
     def as_json
       self.file_format = "json"
-      self
+      ReadResponse.new(self)
     end
 
     # Set request to CSV
     #
-    # @returns [WriteRequest] returns self
+    # @returns [ReadResponse] 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)
+      ReadResponse.new(self)
     end
 
   protected
@@ -219,6 +231,14 @@ class Cloudxls
     end
   end
 
+  class WriteResponse
+    include BaseResponse
+
+    def initialize(req)
+      @request = req
+    end
+  end
+
   class WriteRequest
     include BaseRequest
     # post_data is an array of key,value arrays. Reason:
@@ -257,20 +277,20 @@ class Cloudxls
 
     # Set request to XLS
     #
-    # @returns [WriteRequest] returns self
+    # @returns [WriteResponse] response object without starting the request
     #
     def as_xls
       self.file_format = "xls"
-      self
+      WriteResponse.new(self)
     end
 
     # Set request to XLSX
     #
-    # @returns [WriteRequest] returns self
+    # @returns [WriteResponse] response object without starting the request
     #
     def as_xlsx
       self.file_format = "xlsx"
-      self
+      WriteResponse.new(self)
     end
 
     # Sets request to XLSX

data/test/cloudxls_test.rb

@@ -3,15 +3,15 @@ require 'test_helper'
 class CloudxlsTest < Minitest::Test
   def test_defaults
     Cloudxls.api_key = "test_foo"
-    file = Cloudxls.write(csv: "hello,world").save_as("/tmp/foo.xls")
+    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]
   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
+    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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Sebastian Burkhard