zoro 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Trevor Redfern
+
+MIT License
+
+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,44 @@
+# Zoro [![Build Status](https://secure.travis-ci.org/PayTrace/zoro.png)](http://travis-ci.org/PayTrace/zoro)
+
+A gem for integrating with Zoho.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zoro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zoro
+
+## Usage
+
+First we need an authentication token setup for requests:
+
+    Zoro.auth_token = "SomeAuthToken"
+
+You can customize Faraday behavior for logging or other things by replacing the Zoro connection. I'll probably change this down stream to allow more configurable.
+
+    Zoro.connection = Faraday::Connection.new |conn| do
+      conn.request :url_encoded
+    end
+
+Current this is still very much a work in development, but for generating leads the following works:
+
+    lead = Zoro::Lead.new
+    lead.add_field "First Name", "Foo"
+    lead.add_field "Last Name", "Bar"
+    lead.save!
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+lib_dir = File.expand_path('lib')
+test_dir = File.expand_path('test')
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+task "default" => ["test"]
+

data/examples/add_lead.rb

@@ -0,0 +1,15 @@
+require 'zoro'
+
+Zoro.auth_token = 'some-valid-auth-token'
+Zoro.http_connection = Faraday::Connection.new do |conn|
+  conn.request :url_encoded
+  conn.response :logger #Log Faraday to STDOUT for easier testing
+  conn.adapter Faraday.default_adapter
+end
+
+lead = Zoro::Lead.new
+lead.add_field "First Name", "Test"
+lead.add_field "Last Name", "trevor trevor"
+lead.add_field "Email", "trevor@paytrace.com"
+response = lead.save!
+puts response.body

data/lib/zoro/api.rb

@@ -0,0 +1,15 @@
+require 'faraday'
+
+module Zoro
+  class Api
+    def format_url(mod, method)
+      "https://crm.zoho.com/crm/private/xml/#{mod}/#{method}"
+    end
+
+    def insert_records(record)
+      url = format_url(record.zoho_module, "insertRecords")
+      xml = record.to_xml
+      Zoro.http_connection.get(url, :xmlData => xml, :newformat => 1, :authtoken => Zoro.auth_token, :scope => 'crmapi')
+    end
+  end
+end

data/lib/zoro/lead.rb

@@ -0,0 +1,37 @@
+module Zoro
+  class Lead
+    ZOHO_MODULE = "Leads"
+    attr_accessor :fields, :api
+
+    def initialize(data = {})
+      @fields = {}.merge(data)
+    end
+
+    def save!
+      api.insert_records(self)
+    end
+
+    def api
+      @api ||= Zoro::Api.new
+    end
+
+    def add_field(field_name, value)
+      @fields[field_name] = value
+    end
+
+    def zoho_module
+      ZOHO_MODULE
+    end
+
+    def to_xml
+      xml_map = Hash.new
+      xml_map['row'] = {
+        'no' => '1',
+        'FL' => @fields.map do |k, v|
+          { 'val' => k, 'content' => v}
+        end
+      }
+      XmlSimple.xml_out(xml_map, :RootName => ZOHO_MODULE)
+    end
+  end
+end

data/lib/zoro/version.rb

@@ -0,0 +1,3 @@
+module Zoro
+  VERSION = "0.0.1"
+end

data/lib/zoro.rb

@@ -0,0 +1,14 @@
+require "zoro/version"
+require 'zoro/api'
+require 'zoro/lead'
+require 'faraday'
+require 'xmlsimple'
+
+module Zoro
+  extend self
+  attr_accessor :auth_token, :http_connection
+
+  def http_connection
+    @http_connection ||= Faraday::Connection.new
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'minitest/pride'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+require 'zoro'
+
+
+def stub_http
+  http_stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+  end
+
+  Zoro.http_connection = Faraday::Connection.new do |builder|
+    builder.adapter :test, http_stubs
+  end
+  http_stubs
+end

data/test/zoro/api_test.rb

@@ -0,0 +1,23 @@
+require './test/test_helper'
+require 'zoro/api'
+
+describe Zoro::Api do
+  it "can format the URL to insert lead records" do
+    Zoro.auth_token = "1234"
+    api = Zoro::Api.new
+    url = api.format_url("Leads", "insertRecords")
+    url.must_equal "https://crm.zoho.com/crm/private/xml/Leads/insertRecords"
+  end
+
+  it "can insert records into the zoro CRM" do
+    #Stub HTTP
+    Zoro.auth_token = "1234"
+    stubs = stub_http
+    stubs.get("/crm/private/xml/Leads/insertRecords") {[200, {}, 'foo']}
+
+    record = stub(:zoho_module => "Leads", :to_xml => '<somexml>foo</somexml>')
+    api = Zoro::Api.new
+    api.insert_records(record)
+    stubs.verify_stubbed_calls
+  end
+end

data/test/zoro/lead_test.rb

@@ -0,0 +1,37 @@
+require './test/test_helper'
+require 'zoro/api'
+require 'zoro/lead'
+
+
+describe Zoro::Lead do
+  it "can create new leads" do
+    lead = Zoro::Lead.new
+    api = stub
+    api.expects(:insert_records).with(lead)
+    lead.api = api
+    lead.save!
+  end
+
+  it "defines it's module as Lead" do
+    Zoro::Lead::ZOHO_MODULE.must_equal "Leads"
+  end
+
+  it "can serialize itself to xml" do
+    lead = Zoro::Lead.new
+    lead.add_field "First Name", "foo"
+    lead.add_field "Last Name", "bar"
+    lead.to_xml.must_equal %q{<Leads>
+  <row no="1">
+    <FL val="First Name">foo</FL>
+    <FL val="Last Name">bar</FL>
+  </row>
+</Leads>
+}
+  end
+
+  it "can be constructed with fields" do
+    lead = Zoro::Lead.new({"First Name" => "Foo", "Last Name" => "Bar"})
+    lead.fields["First Name"].must_equal "Foo"
+    lead.fields["Last Name"].must_equal "Bar"
+  end
+end

data/zoro.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zoro/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "zoro"
+  gem.version       = Zoro::VERSION
+  gem.authors       = ["Trevor Redfern"]
+  gem.email         = ["trevor@paytrace.com"]
+  gem.description   = %q{Simple integration library into Zoho CRM. Will be enhanced to provide two way integration with library over time.}
+  gem.summary       = %q{Ruby gem for integration with Zoho CRM}
+  gem.homepage      = "https://github.com/PayTrace/zoro"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('mocha')
+  gem.add_dependency('faraday')
+  gem.add_dependency('xml-simple')
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: zoro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Trevor Redfern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: xml-simple
+  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'
+description: Simple integration library into Zoho CRM. Will be enhanced to provide
+  two way integration with library over time.
+email:
+- trevor@paytrace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/add_lead.rb
+- lib/zoro.rb
+- lib/zoro/api.rb
+- lib/zoro/lead.rb
+- lib/zoro/version.rb
+- test/test_helper.rb
+- test/zoro/api_test.rb
+- test/zoro/lead_test.rb
+- zoro.gemspec
+homepage: https://github.com/PayTrace/zoro
+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: Ruby gem for integration with Zoho CRM
+test_files:
+- test/test_helper.rb
+- test/zoro/api_test.rb
+- test/zoro/lead_test.rb