cloudxls 0.7.0 → 2.0.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e911a06e80702fbc54262bcd3cbc18a062be0a80
+  data.tar.gz: ea552bd27ba131071ffc9208917e4d9eed337a7c
+SHA512:
+  metadata.gz: 8190f8b90d96ef9cf5bfc76f2f843119f8ba9afc6557b59f660eaae3bcff641f068f93a7754ffe5dce526ff6bac1eb0dd67d2e752f5de18478406fd6b13ce8d9
+  data.tar.gz: 441c7f7eed10b3e53683f5c37e38ce2450083e571f56719a28365d445a2177a1b87125a0e5d49bf7580951cfe49867235d2c1b18b52f37e7d8a6bebed54b3c9f

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Sebastian Burkhard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -4,36 +4,131 @@
 
 Or in your Gemfile
 
-    gem 'cloudxls', '~> 0.7.0'
+    gem 'cloudxls', '~> 2.0.0-beta'
 
-To get started, add the following to your PHP script:
+# Documentation
 
-# Useage
+Additional documentation: [https://docs.cloudxls.com](docs.cloudxls.com)
 
-There are various sample code snippets in the examples folder.
+# Quick Start Guide
 
-## Async
+## Set-up API-Keys
+
+Register on https://www.cloudxls.com to get an API key.
+
+Either set the ENV variable `CLOUDXLS_API_KEY` or manually using `Cloudxls.api_key#=`
 
 ```ruby
-CloudXLS.api_key = "YOUR-API-KEY"
+Cloudxls.api_key = "YOUR-API-KEY"
+```
+
+### Sandbox
+
+If you use a sandbox API key (starting with 'test_') the client sends requests
+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.
+
+```ruby
+data = Cloudxls.read(file: File.new("/path/to/my-excel.xls")).to_h
+```
+
+Output
 
-response = CloudXLS.async({
-  :data => {
-    :text => "Greeting,Greetee\nHello,World"
+```json
+[
+  {
+    "name" : "Sheet1",
+    "rows" : [
+      ["hello", "world"],
+      ["lorem", "ipsum"]
+    ]
   }
-})
+]
+```
+
+From a remote url
+
+```ruby
+data = Cloudxls.read(file_url: "http://example.org/data.xls").to_h
+```
+
+Save json to a file
+
+```ruby
+Cloudxls.read(file: File.new("my-excel.xls"))
+  .save_as("output.json")
+```
+
+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|
+  io.write chunk
+end
+io.close
+```
+
+## Write-API
+
+Write a xls file with a single sheet.
+
+```ruby
+csv_string = "hello,world\nfoo,bar"
+
+Cloudxls.write(csv: csv_string)
+  .save_as("/tmp/hello-world.xls")
+```
+
+Write xlsx:
+
+```ruby
+Cloudxls.write(csv: csv_string)
+  .as_xlsx
+  .save_as("/tmp/hello-world.xlsx")
+```
+
+With options:
 
-redirect_to response.url
+```ruby
+req = Cloudxls.write(
+  csv: csv_string,
+  offset: "B2",
+  sheet_name: "Data"
+)
+req.save_as("/tmp/hello-world.xls")
 ```
 
-## Inline
+Multiple sheets:
 
 ```ruby
-CloudXLS.api_key = "YOUR-API-KEY"
+Cloudxls.write(csv: csv_string)
+  .add_data(csv: "more,data")
+  .add_data(csv: "more,data", sheet_name: "foobar")
+  .save_as("/tmp/hello-world.xls")
+```
+
+Append data to a excel file (xls or xlsx)
 
-response = CloudXLS.inline(:data => {
-  :text => "Greeting,Greetee\nHello,World"
-})
+```ruby
+Cloudxls.write(csv: csv_string)
+  .target_file(File.new("/path/to/my-file.xls"))
+  .save_as("/tmp/hello-world.xls")
+```
+
+## Useage in Rails
+
+The most efficient way is to directly stream the cloudxls response to the client.
+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"
 
-File.open("report.xls", 'wb') {|f| f << response }
+  self.response_body = Cloudxls.write(csv: User.all.to_csv)
+end
 ```

data/Rakefile

@@ -1,17 +1,8 @@
 task :default => [:test]
 
-task :test do
-  ret = true
-  Dir["test/**/*.rb"].each do |f|
-    ret = ret && ruby(f, '')
-  end
-  exit(ret)
-end
+require 'rake/testtask'
 
-task :cloudxls_console do
-  require 'irb'
-  require 'irb/completion'
-  require './lib/cloudxls' # You know what to do.
-  ARGV.clear
-  IRB.start
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
 end

data/cloudxls.gemspec

@@ -5,19 +5,19 @@ require "cloudxls/version"
 Gem::Specification.new do |gem|
   gem.name          = "cloudxls"
   gem.authors       = ["Sebastian Burkhard"]
-  gem.email         = ["seb@cloudxls.com"]
-  gem.description   = %q{Ruby wrapper for the CloudXLS xpipe API}
-  gem.summary       = %q{Ruby wrapper for the CloudXLS xpipe API}
+  gem.email         = ["hello@cloudxls.com"]
+  gem.description   = %q{Ruby wrapper to read and write Excel through the cloudxls API.}
+  gem.summary       = %q{Ruby wrapper to read and write Excel through the cloudxls API.}
   gem.homepage      = "https://cloudxls.com"
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ["lib"]
-  gem.version       = CloudXLS::VERSION
 
-  gem.add_dependency('rest-client', '~> 1.4')
+  gem.version       = Cloudxls::VERSION
+
+  gem.add_dependency('multipart-post', '~> 2.0.0')
 
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
 end

data/lib/cloudxls.rb

@@ -1,150 +1,216 @@
-require 'cgi'
-require 'set'
 require 'openssl'
 require 'json'
-require 'date'
-require 'rest_client'
-require 'json'
-
-require_relative 'cloudxls/version'
+require 'net/http'
+require 'net/http/post/multipart'
 
-class CloudXLS
-  @https = true
-  @api_base = 'api.cloudxls.com'.freeze
-  @api_key  = ENV["CLOUDXLS_API_KEY"]
 
-  class << self
-    attr_accessor :api_key, :api_base, :api_version, :https
+class Cloudxls
+  class ApiError < Exception
   end
 
-  def self.api_url(path = '')
-    # @api_base + url
-    "http#{@https ? 's' : ''}://#{@api_key}:@#{@api_base}/v1/#{path}"
-  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
 
+  class << self
+    attr_accessor :api_key,
+                  :api_version,
+                  :api_base,
+                  :sandbox_base,
+                  :port
+
+    def client_options
+      {
+        api_key: self.api_key,
+        api_version: self.api_version,
+        api_base: self.api_base,
+        port: 443
+      }
+    end
 
-  class CloudXLSResponse
-    attr_reader :url, :uuid, :response
+    def write(params = nil, client_options = nil)
+      Write.new(client_options).add_data(params)
+    end
 
-    def initialize(response)
-      data = CloudXLS.parse_response(response)
-      @response = response
-      @url  = data['url']
-      @uuid = data['uuid']
+    def read(params = nil, client_options = nil)
+      Read.new(client_options).add_data(params)
     end
   end
 
+  module BaseRequest
+    def initialize(client_options = nil)
+      @post_data = []
 
-  def self.async(params = {})
-    if params["mode"]
-      params["mode"] = "async"
-    else
-      params[:mode] = "async"
+      @finished  = false
+      @client_options = client_options || Cloudxls.client_options
+    end
+
+    def api_key
+      key = client_options[:api_key]
+      if key.nil?
+        raise "api_key is nil. Configure using CLOUDXLS_API_KEY ENV variable or Cloudxls.api_key = ..."
+      end
+      key
     end
-    CloudXLSResponse.new(convert(params))
-  end
 
+    def test_key?
+      api_key.to_s.downcase.start_with?("test")
+    end
 
-  def self.inline(params = {})
-    if params["mode"]
-      params["mode"] = "inline"
-    else
-      params[:mode] = "inline"
+    def api_base
+      if test_key?
+        Cloudxls.sandbox_base
+      else
+        client_options[:api_base]
+      end
     end
-    convert(params)
-  end
 
+    def start(&block)
+      Net::HTTP.start(api_base, client_options[:port], use_ssl: true, &block)
+    end
 
-  # @example
-  #     CloudXLS.convert :data => {:file => File.new('/path/to/data.csv', 'r')}
-  #     CloudXLS.convert :data => {:file => File.new("foo,bar\nlorem,ipsum")  }
-  #     CloudXLS.convert :data => {:url => "https://example.com/data.csv"}
-  #     CloudXLS.convert :data => {:url => "https://username:password@example.com/data.csv"}
-  #
-  def self.convert(params = {})
-    check_api_key!
+    def path_to(path)
+      "/#{client_options[:api_version]}/#{path}"
+    end
 
-    headers = {}
+    def data
+      each
+    end
 
-    response = execute_request do
-      RestClient.post(api_url("convert"), params, headers)
+    def write_to(io)
+      each do |chunk|
+        io.write chunk
+      end
+      io
+    ensure
+      io.close
     end
 
-    response
-  end
+    def save_as(path)
+      write_to File.open(path, 'wb')
+    end
 
-  # @deprecated
-  def self.xpipe(params = {})
-    convert(params)
+    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 #{Cloudxls::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
 
-  def self.execute_request
-    begin
-      return yield
-    rescue SocketError => e
-      handle_restclient_error(e)
-    rescue NoMethodError => e
-      # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        e = APIConnectionError.new('Unexpected HTTP response code')
-        handle_restclient_error(e)
-      else
-        raise
+  class Read
+    include BaseRequest
+
+    # post_data is an array of key,value arrays. Reason:
+    # - A key can appear multiple times (for multiple sheets)
+    # - Parameters need to be in the right order: template - config - data
+    #
+    # Example: [["separator", ","], ["csv", "hello,world"]]
+    attr_reader :post_data
+    attr_reader :client_options
+
+    DATA_PARAMETERS = %w[excel file]
+
+    def add_data(params)
+      params.map do |key,value|
+        key = key.to_s
+        if DATA_PARAMETERS.include?(key)
+          value = UploadIO.new(value, "text/csv", "data.csv")
+        end
+        @post_data << [key, value]
       end
-    rescue RestClient::ExceptionWithResponse => e
-      if rcode = e.http_code and rbody = e.http_body
-        # TODO
-        # handle_api_error(rcode, rbody)
-        handle_restclient_error(e)
-      else
-        handle_restclient_error(e)
+      self
+    end
+
+    def response_body
+      # TODO: optimize
+      str = ""
+      each do |chunk|
+        str << chunk
       end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e)
+      str
     end
-  end
 
-  def self.parse_response(response)
-    json = JSON.parse(response.body)
-  rescue => e
-    raise general_api_error(response.code, response.body)
-  end
+    def to_h
+      JSON.load(response_body)
+    end
 
-  def self.general_api_error(rcode, rbody)
-    StandardError.new("Invalid response object from API: #{rbody.inspect} " +
-                 "(HTTP response code was #{rcode})" ) #, rcode, rbody)
-  end
+  protected
 
+    def path
+      path_to("read.json")
+    end
+  end
 
+  class Write
+    include BaseRequest
+    # post_data is an array of key,value arrays. Reason:
+    # - A key can appear multiple times (for multiple sheets)
+    # - Parameters need to be in the right order: template - config - data
+    #
+    # Example: [["separator", ","], ["csv", "hello,world"]]
+    attr_reader :post_data
+    attr_reader :client_options
+
+    attr_accessor :file_format
+
+    DATA_PARAMETERS = %w[data data_url csv csv_url json json_url]
+
+    def add_data(params = nil)
+      data_params = []
+      params.each do |key, value|
+        key = key.to_s
+        if DATA_PARAMETERS.include?(key)
+          data_params << [key, value]
+        else
+          @post_data << [key, value]
+        end
+      end
+      @post_data += data_params
+      self
+    end
 
-private
-  def self.handle_restclient_error(e)
-    case e
-    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-      message = "Could not connect to CloudXLS (#{@api_base}). " +
-        "Please check your internet connection and try again. "
-    when RestClient::SSLCertificateNotVerified
-      message = "Could not verify CloudXLS's SSL certificate. " +
-        "Please make sure that your network is not intercepting certificates. "
-    when SocketError
-      message = "Unexpected error communicating when trying to connect to CloudXLS. " +
-        "You may be seeing this message because your DNS is not working. " +
-        "To check, try running 'host cloudxls.com' from the command line."
-    else
-      message = "Unexpected error communicating with CloudXLS. " +
-        "If this problem persists, let us know at support@cloudxls.com."
+    def as_xls
+      self.file_format = "xls"
+      self
     end
 
-    raise StandardError.new(message + "\n\n(Network error: #{e.message})")
-  end
+    def as_xlsx
+      self.file_format = "xlsx"
+      self
+    end
 
-  def self.check_api_key!
-    unless api_key ||= @api_key
-      raise StandardError.new('No API key provided. Set your API key using "CloudXLS.api_key = <API-KEY>". ')
+    def append_to(target_file)
+      @post_data = [["target_file", target_file]] + @post_data
+      self
     end
 
-    if api_key =~ /\s/
-      raise StandardError.new('Your API key is invalid, as it contains whitespace.')
+  protected
+
+    def path
+      if file_format
+        path_to("write.#{file_format}")
+      else
+        path_to("write")
+      end
     end
   end
 

data/lib/cloudxls/version.rb

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

data/test/cloudxls_test.rb

@@ -0,0 +1,22 @@
+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")
+    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
+  end
+
+  def test_test_api_keys
+    Cloudxls::Write.new(api_key: "test_foobar")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'cloudxls'
+require 'minitest/autorun'

metadata

@@ -1,89 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 2.0.0.pre.beta
 platform: ruby
 authors:
 - Sebastian Burkhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby wrapper for the CloudXLS xpipe API
+description: Ruby wrapper to read and write Excel through the cloudxls API.
 email:
-- seb@cloudxls.com
+- hello@cloudxls.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - cloudxls.gemspec
@@ -98,33 +76,31 @@ files:
 - examples/templates.rb
 - lib/cloudxls.rb
 - lib/cloudxls/version.rb
-- lib/data/ca-certificates.txt
-- spec/cloudxls_spec.rb
-- spec/spec_helper.rb
+- test/cloudxls_test.rb
+- test/test_helper.rb
 homepage: https://cloudxls.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
-summary: Ruby wrapper for the CloudXLS xpipe API
+specification_version: 4
+summary: Ruby wrapper to read and write Excel through the cloudxls API.
 test_files:
-- spec/cloudxls_spec.rb
-- spec/spec_helper.rb
+- test/cloudxls_test.rb
+- test/test_helper.rb

data/spec/cloudxls_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-describe "CloudXLS" do
-  before do
-
-  end
-
-  describe "CloudXLS.api_key" do
-    it "should not register api_key" do
-      CloudXLS.api_key = "FOO"
-      expect( CloudXLS.api_key ).to eq("FOO")
-    end
-
-    it "should not register api_key" do
-      CloudXLS.api_key = "FOO"
-      CloudXLS.api_key = "BAR"
-      expect( CloudXLS.api_key ).to eq("BAR")
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,10 +0,0 @@
-ENV["RAILS_ENV"] = 'test'
-require 'bundler'
-require 'bundler/setup'
-require 'cloudxls'
-
-
-RSpec.configure do |config|
-  config.color_enabled = true
-  config.order = "random"
-end