zoho_wrapper 0.0.5 → 0.0.6

data/Gemfile

@@ -1,2 +1,6 @@
 source 'https://rubygems.org'
-gemspec
+group :test do
+  gem 'rspec', '>= 2.12.0'
+  gem 'simplecov', '>= 0.7.1', :require => false, :group => :test
+  gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,71 @@
+# Zoho Wrapper
+
+A gem that wraps up the rubyzoho gem. This gem makes possible to use rubyzoho with more than just one company. It changes the Zoho Token whenever a save operation or a remove operation is called. 
+
+Note: For now, as it is a POC, it is just working with the Lead (Zoho) entity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zoho_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zoho_wrapper
+
+## Usage
+
+There are just few integration configurations before using the gem. The class intended to integrate with the gem needs to include our `Lead` module. So, the class must implement the following methods:
+
+- zoho_lead: that returns the zoho fields to be saved ( see https://github.com/amalc/rubyzoho )
+- zoho_token: The token for connecting with the Zoho account. For more information on how to get a Zoho Authentication Token see https://www.zoho.com/crm/help/api/using-authentication-token.html.
+
+### Example code
+
+```ruby
+class Lead < ActiveRecord::Base
+  include ZohoWrapper::ActiveRecord
+
+  belongs_to :company
+
+  validates :name, :length => { :minimum => 3, :maximum => 60}, :presence => true, :allow_blank => false
+  validates :last_name, :length => { :minimum => 3, :maximum => 60}, :presence => true, :allow_blank => false
+  validates :email, :presence => true
+  validates :company_id, :presence => true
+
+  def fullname
+    "#{name} #{last_name}"
+  end
+
+  def zoho_lead
+    {
+      :first_name => name.dup,
+      :last_name => last_name.dup,
+      :title => job_title.dup,
+      :email => email.dup
+    }
+  end
+
+  def zoho_token
+    company.zoho_token
+  end
+```
+
+### Sample (Station App)
+
+An application using the gem is available at:
+
+- Source code: https://github.com/marcelorxaviers/station_app
+- Running app: https://station-app.herokuapp.com
+
+## Contributing to Zoho Wrapper
+* Pull requests with unit tests or specs and a version branch are welcomed.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push as much as you want.
+* Make sure to add tests for it. 

data/lib/zoho_wrapper/lead.rb

@@ -6,6 +6,7 @@ module ZohoWrapper
 
       begin
         setup_zoho
+        raise "Missing zoho_token" if self.respond_to? :zoho_lead=
         lead = RubyZoho::Crm::Lead.new(self.zoho_lead.dup)
         lead.save
         self.on_zoho = true
@@ -39,6 +40,7 @@ module ZohoWrapper
 
     private
     def setup_zoho
+      raise "Missing zoho_token" if self.respond_to? :zoho_token=
       RubyZoho.configure do |config|
           # 'ed7fc5b8a28a358793dcd162e67c43e1'
           config.api_key = self.zoho_token

data/spec/lead_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+ 
+class Lead
+  include ZohoWrapper::ActiveRecord
+  
+  attr_accessor :name, :last_name, :title, :email
+  
+  def initialize name, last_name, title, email
+    @name = name
+    @last_name = last_name
+    @title = title
+    @email = email
+  end
+end
+
+describe Lead do
+ describe "#new" do
+   it "takes four parameters and returns a Lead object" do
+    @lead.should be_an_instance_of Lead
+   end
+ end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/zoho_wrapper.rb'
+require_relative '../lib/zoho_wrapper/lead.rb'
+ 
+require 'yaml'

data/zoho_wrapper.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "zoho_wrapper"
-  spec.version       = "0.0.5"
+  spec.version       = "0.0.6"
   spec.authors       = ["marcelorxs"]
   spec.email         = ["marcelorxs@gmail.com"]
   spec.summary       = "A gem for accessing Zoho CRM API"
@@ -15,11 +15,11 @@ Gem::Specification.new do |spec|
   spec.platform              = Gem::Platform::RUBY
   spec.required_ruby_version = ">= 1.9.3"
   spec.files         = `git ls-files -z`.split("\x0")
-  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  # spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
   spec.require_paths = ["lib"]
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 0"
   spec.add_development_dependency "rspec", "~> 0"
+  spec.add_development_dependency "rubyzoho", "~> 0.2.0"
   spec.add_dependency "rubyzoho", "~> 0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zoho_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-03 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzoho
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubyzoho
   requirement: !ruby/object:Gem::Requirement
@@ -86,11 +102,13 @@ files:
 - .ruby-version
 - Gemfile
 - Gemfile.lock
-- README.rdoc
+- README.md
 - Rakefile
 - config.ru
 - lib/zoho_wrapper.rb
 - lib/zoho_wrapper/lead.rb
+- spec/lead_spec.rb
+- spec/spec_helper.rb
 - zoho_wrapper.gemspec
 homepage: http://github.com/marcelorxaviers/zoho_wrapper
 licenses:

data/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.