cloudxls 0.3.0 → 0.4.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/cloudxls.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "rspec"
 end

data/lib/cloudxls/csv_writer.rb

@@ -0,0 +1,108 @@
+require 'csv'
+
+module CloudXLS
+  class CSVWriter
+    DATETIME_FORMAT = "%FT%T.%L%z".freeze
+    DATE_FORMAT = "%F".freeze
+
+    # Generates CSV string.
+    #
+    # @param [Array<String/Symbol>] columns
+    #   Method/attribute keys to for the export.
+    #
+    # @return [String]
+    #   The full CSV as a string. Titleizes *columns* for the header.
+    #
+    def self.text(scope, options = {})
+      columns = options[:columns]
+
+      str = ::CSV.generate do |csv|
+
+        if options[:skip_headers] != true
+          if scope.respond_to?(:column_names)
+            columns ||= scope.column_names
+          end
+          if columns
+            csv << csv_titles(columns, :titleize)
+          end
+        end
+
+        enum = scope_enumerator(scope)
+        scope.send(enum) do |record|
+          csv << csv_row(record, columns)
+        end
+      end
+      str.strip!
+    end
+
+    # Example
+    #
+    #     Post.csv_enumerator(Post.all, [:title, :author, :published_at])
+    #
+    # @param [ActiveRecord::Scope] scope
+    #   An activerecord scope object for the records to be exported.
+    #   Example: Post.all.limit(500).where(author: "foo")
+    #
+    # @return [Enumerator] enumerator to use for streaming response.
+    #
+    def self.enumerator(scope, options = {})
+      columns = options[:columns]
+
+      Enumerator.new do |row|
+        if options[:skip_headers] != true
+          if scope.respond_to?(:column_names)
+            columns ||= scope.column_names
+          end
+          if columns
+            row << csv_titles(columns, :titleize).to_csv
+          end
+        end
+
+        enum = scope_enumerator(scope)
+        scope.send(enum) do |record|
+          row << csv_row(record, columns).to_csv
+        end
+      end
+    end
+
+  private
+
+
+    def self.csv_row(obj, columns = [])
+      if obj.is_a?(Array)
+        obj.map{ |el| encode_for_csv(el) }
+      else
+        columns.map do |key|
+          encode_for_csv(obj.send(key))
+        end
+      end
+    end
+
+
+    def self.encode_for_csv(val)
+      case val
+      when DateTime,Time then val.strftime(DATETIME_FORMAT)
+      when Date          then val.strftime(DATE_FORMAT)
+      else
+        val
+      end
+    end
+
+    def self.csv_titles(column_names, strategy = :titleize)
+      column_names.map do |c|
+        title = c.to_s
+        title = title.send(strategy) if title.respond_to?(strategy)
+        title
+      end
+    end
+
+
+    def self.scope_enumerator(scope)
+      if scope.respond_to?(:find_each)
+        :find_each
+      else
+        :each
+      end
+    end
+  end
+end

data/lib/cloudxls/version.rb

@@ -1,3 +1,3 @@
 module CloudXLS
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/cloudxls.rb

@@ -6,12 +6,13 @@ require 'rest_client'
 require 'multi_json'
 
 require 'cloudxls/version'
+require 'cloudxls/csv_writer'
 
 module CloudXLS
   @https = true
   @api_base = 'cloudxls.com'.freeze
   @api_key  = ENV["CLOUDXLS_API_KEY"]
-  @ssl_bundle_path  = File.dirname(__FILE__) + '/data/ca-certificates.crt'
+  # @ssl_bundle_path  = File.dirname(__FILE__) + '/data/ca-certificates.crt'
   @verify_ssl_certs = true
 
   class << self

data/spec/csv_writer_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe "CloudXLS::CSVWriter" do
+  before do
+    @writer = CloudXLS::CSVWriter
+  end
+
+  describe "with array" do
+    it "should not titleize" do
+      expect( @writer.text([['foo','bar'],[1,2]]) ).to eq("foo,bar\n1,2")
+    end
+
+    it "should escape titles" do
+      expect( @writer.text([['bar"baz']]) ).to eq("\"bar\"\"baz\"")
+    end
+
+    it "should escape rows" do
+      expect( @writer.text([['title'],['bar"baz']]) ).to eq("title\n\"bar\"\"baz\"")
+    end
+
+    it "should write YYYY-MM-DD for Date" do
+      expect( @writer.text([[Date.new(2012,12,24)]]) ).to eq("2012-12-24")
+    end
+
+    it "should write xmlschema for DateTime" do
+      # TODO: make UTC consistent
+      expect( @writer.text([[DateTime.new(2012,12,24,18,30,5,'+0000')]])             ).to eq("2012-12-24T18:30:05.000+0000")
+      expect( @writer.text([[DateTime.new(2012,12,24,18,30,5,'+0000').to_time.utc]]) ).to eq("2012-12-24T18:30:05.000+0000")
+    end
+
+    it "should write nothing for nil" do
+      expect( @writer.text([[nil,nil]]) ).to eq(",")
+    end
+
+    it "should write \"\" for empty string" do
+      expect( @writer.text([["",""]]) ).to eq('"",""')
+    end
+
+    it "should write integers" do
+      expect( @writer.text([[-1,0,1,1_000_000]]) ).to eq('-1,0,1,1000000')
+    end
+
+    it "should write floats" do
+      expect( @writer.text([[-1.0,0.0,1.0,1_000_000.0,1.234567]]) ).to eq('-1.0,0.0,1.0,1000000.0,1.234567')
+    end
+  end
+
+  # describe "#text with AR" do
+  #   before do
+  #     Post.delete_all
+  #     @post = Post.create(
+  #       :title           => "hello world",
+  #       :visits          => 12_032,
+  #       :conversion_rate => 0.24,
+  #       :published_on    => Date.new(2013,12,24),
+  #       :expired_at      => DateTime.new(2013,12,25,12,30,30),
+  #       :unix_timestamp  => DateTime.new(2013,12,25,12,30,30),
+  #       :published       => false)
+  #   end
+
+  #   it "given no records should just return titles" do
+  #     Post.delete_all
+  #     expect( @writer.text(Post.all, :columns => [:title, :visits]) ).to eq("Title,Visits")
+  #   end
+
+  #   it "should work with a Post.all" do
+  #     expect( @writer.text(Post.all, :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
+  #   end
+
+  #   it "should work with a Post.limit" do
+  #     expect( @writer.text(Post.limit(10), :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
+  #   end
+
+  #   it "should work with a Post.all.to_a" do
+  #     expect( @writer.text(Post.all.to_a, :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
+  #   end
+
+  #   it "should write xmlschema for DateTime" do
+  #     expect( @writer.text(Post.all, :columns => [:expired_at]) ).to eq("Expired At\n2013-12-25T12:30:30.000+0000")
+  #   end
+
+  #   it "should write YYYY-MM-DD for Date" do
+  #     expect( @writer.text(Post.all, :columns => [:published_on]) ).to eq("Published On\n2013-12-24")
+  #   end
+  # end
+end

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -104,14 +104,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - cloudxls.gemspec
 - lib/cloudxls.rb
+- lib/cloudxls/csv_writer.rb
 - lib/cloudxls/version.rb
 - lib/data/ca-certificates.txt
+- spec/csv_writer_spec.rb
+- spec/spec_helper.rb
 homepage: https://cloudxls.com
 licenses: []
 post_install_message: 
@@ -136,4 +139,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the CloudXLS xpipe API
-test_files: []
+test_files:
+- spec/csv_writer_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cloudxls (0.1.0)
-      multi_json (>= 1.0.4, < 2)
-      rest-client (~> 1.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.5)
-    crack (0.4.1)
-      safe_yaml (~> 0.9.0)
-    mime-types (1.25)
-    minitest (5.0.8)
-    multi_json (1.8.0)
-    rake (10.1.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    safe_yaml (0.9.7)
-    webmock (1.13.0)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  cloudxls!
-  minitest
-  rake
-  webmock