salesforce_exporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0f2d9f4858712229df6e56b8df76dbd4944a457
+  data.tar.gz: edcb4cc32c7b199c2011244b95337f9ba4011e77
+SHA512:
+  metadata.gz: 4a0c9557eb3ff568b9980506e686053840decfc9745c7587615e9e2d076c5ab832a147cd5edfe8b90b9c75e2cdbba33753f216e05ed89595e895f5e40a7dba35
+  data.tar.gz: c879213187fb80685bb0a81079daf7974d211dbd4654816da3c370e1bd4d623552f659a361342ed17264711b7742b0438817190de01c43d1fac8447113f7ac47

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce_exporter.gemspec
+gemspec
+
+group :test, :development do
+  gem "coveralls", require: false
+  gem "guard"
+  gem "guard-rspec"
+  gem "simplecov"
+  gem "pry"
+
+  gem "rb-inotify", require: false
+  gem "rb-fsevent", require: false
+  gem "rb-fchange", require: false
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: "rspec --tag ~type:integration" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2015 Leif Gensert, Propertybase GmbH
+
+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

@@ -0,0 +1,55 @@
+# SalesforceExporter
+
+This gem can be used to export salesforce objects to an SQLite database. Datatypes and indexes will be preserved.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salesforce_exporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce_exporter
+
+## Usage
+
+### Authentication
+
+The SalesforceExporter client just passes on the credentials to the underlying client [restforce](https://github.com/ejholmes/restforce). You can use exactly the same parameters as specified in the [README of Restforce](https://github.com/ejholmes/restforce#initialization)
+
+```ruby
+client = SalesforceExporter.new(
+  oauth_token:      'access_token',
+  refresh_token:    'refresh token',
+  instance_url:     'instance url',
+  client_id:        'client_id',
+  client_secret:    'client_secret',
+)
+```
+
+### Export
+
+In order to start the export, you need to specify the objects and and SQLite connection string. The exporter will return the database object after finish.
+
+```ruby
+db = client.export(objects: ["Contact", "Account"], to: "sqlite://test.db")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/salesforce_exporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "salesforce_exporter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/salesforce_exporter.rb

@@ -0,0 +1,12 @@
+require "salesforce_exporter/version"
+require "salesforce_exporter/client"
+
+require "restforce"
+
+module SalesforceExporter
+  class << self
+    def new(*args)
+      SalesforceExporter::Client.new(Restforce.new(*args))
+    end
+  end
+end

data/lib/salesforce_exporter/client.rb

@@ -0,0 +1,18 @@
+require "salesforce_exporter/schema"
+require "salesforce_exporter/sqlite_writer"
+
+module SalesforceExporter
+  class Client
+    attr_reader :sf_client
+
+    def initialize(sf_client)
+      @sf_client = sf_client
+    end
+
+    def export(objects:, to:)
+      object_descriptions = Array(objects).map { |o| sf_client.describe(o) }
+      db = SalesforceExporter::Schema.new(object_descriptions, to).create
+      SalesforceExporter::SqliteWriter.new(sf_client, db, object_descriptions).write
+    end
+  end
+end

data/lib/salesforce_exporter/schema.rb

@@ -0,0 +1,84 @@
+require "sequel"
+require "sqlite3"
+
+module SalesforceExporter
+  class Schema
+    attr_reader :objects
+    attr_reader :db
+
+    def initialize(objects, db)
+      @objects = objects
+      @db = Sequel.connect(db)
+    end
+
+    def create
+      objects.each do |object|
+        columns = self.class.columns(object["fields"].reject{|f| f["calculated"] })
+        db.create_table!(object["name"]) do
+          columns.each do |column_definition|
+            send(*column_definition)
+          end
+        end
+      end
+      db
+    end
+
+    private
+
+    def self.coulumn_type(field)
+      type_mapping.fetch(field["type"])
+    end
+
+    def self.columns(fields)
+      fields.map { |f| column_options(f) }
+    end
+
+    def self.column_options(field)
+      method_name, _ = coulumn_type(field)
+      [method_name, field["name"], nil, options(field) ]
+    end
+
+    def self.options(field)
+      _, type = coulumn_type(field)
+      base = { unique: field["unique"], null: field["nillable"], type: type }
+      base.merge!(size: field["length"]) if field["length"] > 0
+
+      if type == :decimal
+        base.merge!(size: [field["precision"], field["scale"]])
+      end
+
+      # reference = field["referenceTo"].first
+      # if reference
+      #   base.merge!(table: Sequel.identifier(reference.to_sym))
+      # end
+
+      if type == :integer
+        base.merge!(size: field["digits"])
+      end
+
+      if field["name"].downcase == "id"
+        base.merge!(primary_key: true)
+      end
+      base
+    end
+
+    def self.type_mapping
+      @_type_mapping ||= {
+        "email" => [:column, "VARCHAR"],
+        "double" => [:column, "DECIMAL"],
+        "int" => [:column, "INTEGER"],
+        "currency" => [:column, "DECIMAL"],
+        "url" => [:column, "VARCHAR"],
+        "id" => [:column, "VARCHAR"],
+        "date" => [:column, "DATE"],
+        "datetime" => [:column, "DATETIME"],
+        "reference" => [:foreign_key, "VARCHAR"],
+        "string" => [:column, "VARCHAR"],
+        "picklist" => [:column, "VARCHAR"],
+        "phone" => [:column, "VARCHAR"],
+        "boolean" => [:column, "BOOLEAN"],
+        "textarea" => [:column, "TEXT"],
+      }
+    end
+  end
+end

data/lib/salesforce_exporter/sqlite_writer.rb

@@ -0,0 +1,30 @@
+module SalesforceExporter
+  class SqliteWriter
+    attr_reader :sf_client
+    attr_reader :db
+    attr_reader :objects
+
+    def initialize(sf_client, db, objects)
+      @sf_client = sf_client
+      @db = db
+      @objects = objects
+    end
+
+    def write
+      objects.each do |object|
+        sf_client.query(self.class.build_query(object)).each do |row|
+          db[object["name"].to_sym] << row.attrs
+        end
+      end
+      db
+    end
+
+    private
+
+    def self.build_query(object)
+      record = object["name"]
+      fields = object["fields"].reject{|f| f["calculated"] }.map{|f| f["name"]}.join(",")
+      "select #{fields} from #{record}"
+    end
+  end
+end

data/lib/salesforce_exporter/version.rb

@@ -0,0 +1,3 @@
+module SalesforceExporter
+  VERSION = "0.1.0"
+end

data/salesforce_exporter.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce_exporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce_exporter"
+  spec.version       = SalesforceExporter::VERSION
+  spec.authors       = ["Leif Gensert"]
+  spec.email         = ["leif@propertybase.com"]
+
+  spec.summary       = %q{Gem to export salesforce data to SQLite.}
+  spec.description   = %q{This gem lets you export selected Salesforce Objects to SQLite.}
+  spec.license        = "MIT"
+  spec.homepage      = "http://www.propertybase.com"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "restforce", "~> 2.1"
+  spec.add_dependency "sequel", "~> 4.29"
+  spec.add_dependency "sqlite3"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leif Gensert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.29'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem lets you export selected Salesforce Objects to SQLite.
+email:
+- leif@propertybase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/salesforce_exporter.rb
+- lib/salesforce_exporter/client.rb
+- lib/salesforce_exporter/schema.rb
+- lib/salesforce_exporter/sqlite_writer.rb
+- lib/salesforce_exporter/version.rb
+- salesforce_exporter.gemspec
+homepage: http://www.propertybase.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to export salesforce data to SQLite.
+test_files: []