cloudxls-rails 0.3.0

data/.gitignore

@@ -0,0 +1,15 @@
+Gemfile.lock*
+.bundle
+
+Gemfile.lock
+Gemfile.lock.*
+.bundle/
+log/*.log
+pkg/
+spec/test_app/db/*.sqlite3
+spec/test_app/log/*.log
+spec/test_app/tmp/
+.DS_Store
+/tmp
+
+coverage/*

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+gemspec
+
+case ENV['RAILS_VERSION']
+when '3.1', '3.2'
+  gem 'rails', "~> #{ENV['RAILS_VERSION']}.0"
+when '4.0'
+  gem 'rails'
+end

data/README.md

@@ -0,0 +1,3 @@
+# cloudxls-rails gem
+
+This is a simple wrapper for the cloudxls api.

data/Rakefile

@@ -0,0 +1,9 @@
+task :default => [:test]
+
+task :test do
+  ret = true
+  Dir["test/**/*.rb"].each do |f|
+    ret = ret && ruby(f, '')
+  end
+  exit(ret)
+end

data/cloudxls-rails.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push(File.expand_path "../lib", __FILE__)
+require "cloudxls-rails/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "cloudxls-rails"
+  gem.authors       = ["Sebastian Burkhard"]
+  gem.email         = ["seb@cloudxls.com"]
+  gem.description   = %q{Rails wrapper for the CloudXLS xpipe API}
+  gem.summary       = %q{Rails wrapper for the CloudXLS xpipe 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::Rails::VERSION
+
+  gem.add_dependency('cloudxls', '~> 0.3.0')
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "capybara"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/cloudxls-rails/action_controller.rb

@@ -0,0 +1,66 @@
+require 'csv'
+require 'action_controller'
+
+unless defined? Mime::XLS
+  Mime::Type.register "application/vnd.ms-excel", :xls
+end
+
+unless defined? Mime::XLSX
+  Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+end
+
+ActionController::Renderers.add :csv do |scope, options|
+  filename = options.fetch(:filename, 'data.csv')
+  columns  = options[:columns]
+
+  if options.fetch(:stream, false) == true
+    # streaming response
+    headers["Content-Type"] = "text/csv"
+    headers["Content-disposition"] = "attachment; filename=\"#{filename}\""
+    headers["Cache-Control"] ||= "no-cache"
+    headers.delete("Content-Length")
+    response.status = 200
+
+    stream = CloudXLS::CSVWriter.enumerator(scope, {:columns => columns})
+    self.response_body = stream
+  else # no stream:
+    data = CloudXLS::CSVWriter.text(scope, {:columns => columns})
+
+    send_data data,
+      type: Mime::CSV,
+      disposition: "attachment; filename=#{filename}.csv"
+  end
+end
+
+ActionController::Renderers.add :xls do |scope, options|
+  columns  = options.fetch(:columns, nil)
+
+  data     = CloudXLS::CSVWriter.text(scope, {:columns => columns})
+  response = CloudXLS.xpipe(data:  { text: data })
+
+  redirect_to response.url
+end
+
+ActionController::Renderers.add :xlsx do |scope, options|
+  columns  = options.fetch(:columns, nil)
+
+  data     = CloudXLS::CSVWriter.text(scope, {:columns => columns})
+  response = CloudXLS.xpipe(:data => {:text => data }, doc: {:format => "xlsx"})
+
+  redirect_to response.url
+end
+
+# For respond_to default
+class ActionController::Responder
+  def to_csv
+    controller.render({:csv => resources.last, :stream => false }.merge(options))
+  end
+
+  def to_xls
+    controller.render({:xls => resources.last, :stream => false }.merge(options))
+  end
+
+  def to_xlsx
+    controller.render({:xlsx => resources.last, :stream => false}.merge(options))
+  end
+end

data/lib/cloudxls-rails/csv_writer.rb

@@ -0,0 +1,103 @@
+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
+          row << ::CSV.generate_line(csv_titles(columns, :titleize))
+        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-rails/version.rb

@@ -0,0 +1,5 @@
+module CloudXLS
+  module Rails
+    VERSION = '0.3.0'
+  end
+end

data/lib/cloudxls-rails.rb

@@ -0,0 +1,6 @@
+require 'cloudxls-rails/version'
+require 'cloudxls-rails/csv_writer'
+require 'cloudxls-rails/action_controller'
+
+module CloudXLS
+end

data/spec/ci.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+cd spec/test_app && bundle install --quiet --without debug && bundle exec rake db:create  --quiet && bundle exec rake db:migrate --quiet && cd ../../ && bundle exec rspec spec

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/integration_spec.rb

@@ -0,0 +1,34 @@
+require 'ostruct'
+require 'spec_helper'
+
+describe 'Request', :type => :request do
+  before :each 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 "has a working test_app" do
+    visit '/'
+    page.should have_content "Users"
+  end
+
+  it "/posts.csv has a working csv export" do
+    visit '/posts.csv'
+    page.should have_content [
+      "Title,Visits,Conversion Rate,Published On,Published,Expired At",
+      "hello world,12032,0.24,2013-12-24,false,2013-12-25T12:30:30.000+0000"
+    ].join("\n")
+  end
+
+  it "/posts.xls has a working csv export" do
+    CloudXLS.should_receive(:xpipe).and_return(OpenStruct.new(:url => "/successful_redirect"))
+    visit '/posts.xls'
+  end
+end

data/spec/mime_types_spec.rb

@@ -0,0 +1,28 @@
+require'spec_helper'
+
+describe 'renderer and mime types' do
+
+  it "is registered" do
+    ActionController::Renderers::RENDERERS.include?(:xlsx)
+    ActionController::Renderers::RENDERERS.include?(:xls)
+    ActionController::Renderers::RENDERERS.include?(:csv)
+  end
+
+  it "xlsx mime type" do
+    Mime::XLSX.should be
+    Mime::XLSX.to_sym.should == :xlsx
+    Mime::XLSX.to_s.should == "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+  end
+
+  it "xls mime type" do
+    Mime::XLS.should be
+    Mime::XLS.to_sym.should == :xls
+    Mime::XLS.to_s.should == "application/vnd.ms-excel"
+  end
+
+  it "csv mime type" do
+    Mime::CSV.should be
+    Mime::CSV.to_sym.should == :csv
+    Mime::CSV.to_s.should == "text/csv"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+ENV["RAILS_ENV"] = 'test'
+require File.expand_path("../test_app/config/environment", __FILE__)
+require 'bundler'
+require 'bundler/setup'
+require 'rspec/rails'
+require 'capybara/rspec'
+
+# Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end
+
+module ::RSpec::Core
+  class ExampleGroup
+    include Capybara::DSL
+    include Capybara::RSpecMatchers
+  end
+end

data/spec/test_3.1.sh

@@ -0,0 +1,16 @@
+export RAILS_ENV=test
+
+for version in 3.1
+do
+  echo "Testing Rails version " $version
+  rm Gemfile.lock
+  if [ -f Gemfile.lock.$version ];
+  then
+    echo Reusing Gemfile.lock.$version
+    cp Gemfile.lock.$version Gemfile.lock
+  fi
+  rm spec/test_app/db/test.sqlite3
+  export RAILS_VERSION=$version
+  spec/ci.sh
+  cp Gemfile.lock Gemfile.lock.$version
+done

data/spec/test_3.2.sh

@@ -0,0 +1,16 @@
+export RAILS_ENV=test
+
+for version in 3.2
+do
+  echo "Testing Rails version " $version
+  rm Gemfile.lock
+  if [ -f Gemfile.lock.$version ];
+  then
+    echo Reusing Gemfile.lock.$version
+    cp Gemfile.lock.$version Gemfile.lock
+  fi
+  rm spec/test_app/db/test.sqlite3
+  export RAILS_VERSION=$version
+  spec/ci.sh
+  cp Gemfile.lock Gemfile.lock.$version
+done

data/spec/test_4.0.sh

@@ -0,0 +1,16 @@
+export RAILS_ENV=test
+
+for version in 4.0
+do
+  echo "Testing Rails version " $version
+  rm Gemfile.lock
+  if [ -f Gemfile.lock.$version ];
+  then
+    echo Reusing Gemfile.lock.$version
+    cp Gemfile.lock.$version Gemfile.lock
+  fi
+  rm spec/test_app/db/test.sqlite3
+  export RAILS_VERSION=$version
+  spec/ci.sh
+  cp Gemfile.lock Gemfile.lock.$version
+done

data/spec/test_all_rails.sh

@@ -0,0 +1,6 @@
+spec/test_3.1.sh
+spec/test_3.2.sh
+spec/test_4.0.sh
+
+cp Gemfile.lock.orig Gemfile.lock
+bundle install --quiet

data/spec/test_app/.rspec

@@ -0,0 +1 @@
+--color