Add basic gem skeleton with an optimistic writeup

Author: ahorner

.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.ruby-gemset
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/config/*
+
+.DS_Store

.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in restforce-db.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Horner
+
+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.

README.md

@@ -0,0 +1,39 @@
+# Restforce::DB
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/restforce/db`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "restforce-db"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restforce-db
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/ahorner/restforce-db/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

lib/restforce/db.rb

@@ -0,0 +1,28 @@
+require "restforce"
+
+require "restforce/db/version"
+require "restforce/db/configuration"
+
+module Restforce
+
+  module DB
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+  end
+
+end

lib/restforce/db/configuration.rb

@@ -0,0 +1,20 @@
+module Restforce
+
+  module DB
+
+    class Configuration
+
+      attr_accessor *%i(
+        username
+        password
+        security_token
+        client_id
+        client_secret
+        host
+      )
+
+    end
+
+  end
+
+end

lib/restforce/db/version.rb

@@ -0,0 +1,9 @@
+module Restforce
+
+  module DB
+
+    VERSION = "0.1.0"
+
+  end
+
+end

restforce-db.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "restforce/db/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "restforce-db"
+  spec.version       = Restforce::DB::VERSION
+  spec.authors       = ["Andrew Horner"]
+  spec.email         = ["[email protected]"]
+
+  spec.summary       = "Bind your database to Salesforce data"
+  spec.description   = %q(
+    This gem provides two-way bindings between Salesforce records and records
+    in an ActiveRecord-compatible database. It leans on the Restforce library
+    for Salesforce API interactions, and provides a self-daemonizing binary
+    which keeps records in sync by way of a tight polling loop.
+  )
+  spec.homepage      = "https://www.github.com/ahorner/restforce-db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "restforce"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

test/lib/restforce/db_test.rb

@@ -0,0 +1,24 @@
+require_relative "../../test_helper"
+
+describe Restforce::DB do
+
+  before do
+    Restforce::DB.configure do |config|
+      config.username       = Secrets["client"]["username"]
+      config.password       = Secrets["client"]["password"]
+      config.security_token = Secrets["client"]["security_token"]
+      config.client_id      = Secrets["client"]["client_id"]
+      config.client_secret  = Secrets["client"]["client_secret"]
+      config.host           = Secrets["client"]["host"]
+    end
+  end
+
+  it "configures the Restforce::DB" do
+    Restforce::DB.configuration.username.must_equal Secrets["client"]["username"]
+    Restforce::DB.configuration.password.must_equal Secrets["client"]["password"]
+    Restforce::DB.configuration.security_token.must_equal Secrets["client"]["security_token"]
+    Restforce::DB.configuration.client_id.must_equal Secrets["client"]["client_id"]
+    Restforce::DB.configuration.client_secret.must_equal Secrets["client"]["client_secret"]
+    Restforce::DB.configuration.host.must_equal Secrets["client"]["host"]
+  end
+end

test/test_helper.rb

@@ -0,0 +1,8 @@
+require "minitest/autorun"
+require "yaml"
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "restforce/db"
+
+secrets_file = File.expand_path("../config/secrets.yml", __FILE__)
+Secrets = YAML.load_file(secrets_file)