databasedotcom-convenience 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012 Johnneylee Jack Rollins
+
+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,97 @@
+# databasedotcom-convenience
+
+A convenience module to make talking to databasedotcom convenient.
+
+#Installation
+    gem install databasedotcom-convenience
+
+or, if you use Bundler
+
+    gem 'databasedotcom-convenience'
+
+# Usage
+
+* Include `Databasedotcom::Convenience` into your class
+
+* Create a YAML file at 'config/databasedotcom.yml' derived from your project root.
+* Example below:
+
+        ---
+        client_id: put-your-client-id-here
+        client_secret: put-your-client-secret-here
+        username: put-your-username-here
+        password: put-your-password-here
+        debugging: true
+
+  Alternatively, include environment-specific settings:
+        development:
+            client_id: ...
+        test:
+            client_id: ...
+        production:
+            client_id: ...
+
+
+
+# Rails example
+
+    class UsersController < ApplicationController
+      include Databasedotcom::Convenience
+      before_filter :load_user, :except => [:index, :new]
+
+      def index
+        @users = User.all
+      end
+
+      def show
+      end
+
+      def new
+        @user = User.new
+      end
+
+      def create
+        User.create User.coerce_params(params[:user])
+        flash[:info] = "The user was created!"
+        redirect_to users_path
+      end
+
+      def edit
+      end
+
+      def update
+        @user.update_attributes User.coerce_params(params[:user])
+        flash[:info] = "The user was updated!"
+        redirect_to user_path(@user)
+      end
+
+      def destroy
+        @user.delete
+        flash[:info] = "The user was deleted!"
+        redirect_to users_path
+      end
+
+      private
+
+      def load_user
+        @user = User.find(params[:id])
+      end
+    end
+
+# Example
+    module Service::Databasedotcom
+      include Databasedotcom::Convenience
+
+      def self.build_user id
+        @user = User.find id
+        @user['fullname'] = [@user.first_name, @user.last_name].join "  "
+      end
+    end
+
+This is a contrived example. Check out the `databasedotcom` gem for more information on querying.
+
+Note that there is no need to declare the User class anywhere- `Databasedotcom::Convenience` recognizes it as a known Sobject type from your database.com instance, and materializes it automatically.
+
+# License
+
+databasedotcom-convenience is released under the MIT License

data/lib/databasedotcom-convenience.rb

@@ -0,0 +1 @@
+require 'databasedotcom/convenience'

data/lib/databasedotcom/convenience.rb

@@ -0,0 +1,3 @@
+require 'databasedotcom'
+require 'databasedotcom/convenience/base'
+require 'databasedotcom/convenience/version'

data/lib/databasedotcom/convenience/base.rb

@@ -0,0 +1,62 @@
+module Databasedotcom
+  module Convenience
+
+    def self.env
+      return ENV['RAILS_ENV'].to_sym unless ENV['RAILS_ENV'].nil?
+      return ENV['RACK_ENV'].to_sym  unless ENV['RACK_ENV'].nil?
+      return ENV['APP_ENV'].to_sym   unless ENV['APP_ENV'].nil?
+      return :development
+    end
+
+    module ClassMethods
+
+      def dbdc_client
+        unless @dbdc_client
+          config = YAML.load_file(File.join(File.join Dir.pwd, 'config', 'databasedotcom.yml'))
+          config = config.has_key?(::Databasedotcom::Convenience.env) ? config[::Databasedotcom::Convenience.env] : config
+          username = config["username"]
+          password = config["password"]
+          @dbdc_client = Databasedotcom::Client.new(config)
+          @dbdc_client.authenticate(:username => username, :password => password)
+        end
+
+        @dbdc_client
+      end
+
+      def dbdc_client=(client)
+        @dbdc_client = client
+      end
+
+      def sobject_types
+        unless @sobject_types
+          @sobject_types = dbdc_client.list_sobjects
+        end
+
+        @sobject_types
+      end
+
+      def const_missing(sym)
+        if sobject_types.include?(sym.to_s)
+          dbdc_client.materialize(sym.to_s)
+        else
+          super
+        end
+      end
+    end
+
+    module InstanceMethods
+      def dbdc_client
+        self.class.dbdc_client
+      end
+
+      def sobject_types
+        self.class.sobject_types
+      end
+    end
+
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.send(:extend, ClassMethods)
+    end
+  end
+end

data/lib/databasedotcom/convenience/version.rb

@@ -0,0 +1,5 @@
+module Databasedotcom
+  module Convenience
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: databasedotcom-convenience
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Johnneylee Jack Rollins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: databasedotcom
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+description: Convenience classes to make using the databasedotcom gem even easier
+email:
+- Johnneylee Jack Rollins
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- MIT-LICENSE
+- lib/databasedotcom/convenience/base.rb
+- lib/databasedotcom/convenience/version.rb
+- lib/databasedotcom/convenience.rb
+- lib/databasedotcom-convenience.rb
+homepage: http://github.com/Spaceghost/databasedotcom-convenience
+licenses: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Convenience classes to make using the databasedotcom gem even easier
+test_files: []