v_tiger 0.0.1.3

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/data
+.DS_Store

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@vtr

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in vtiger-ruby.gemspec
+gemspec
+gem 'guard'
+gem 'guard-rspec'
+gem 'rb-fsevent'
+gem 'growl'

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/.+\.rb$})       { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/v_tiger/api.rb

@@ -0,0 +1,29 @@
+module VTiger::API
+  def list_types
+    get('listtypes')['result']['types']
+  end
+
+  def describe(element_type)
+    get('describe', :elementType => element_type)['result']
+  end
+  
+  def create(elementType, element = {})
+    post('create', :elementType => elementType, :element => element.to_json)
+  end
+  
+  def retrieve(id)
+    get('retrieve', :id => id)    
+  end
+  
+  def query(query_string)
+    get('query', :query => query_string)
+  end
+  
+  def update(element)
+    post('update', :element => element)
+  end
+  
+  def delete(id)
+    post('delete', :id => id)
+  end
+end

data/lib/v_tiger/query.rb

@@ -0,0 +1,31 @@
+module VTiger::Query
+  
+  def build_query(objectType, options = {})
+    @objectType     = objectType
+    @options        = options
+    @query           = get('query', :query => query_string)
+    @query['result'] += get_more while more_results_needed?
+    @query
+  end
+  
+  def query_string(options = {})
+    limit = options[:limit] || @options[:limit]
+    [].tap do |query|
+      query << 'select'
+      query << '*'
+      query << "from #{@objectType}"
+      query << "limit #{limit}" if limit
+      query << ';'
+    end.join(' ')
+  end
+  
+  def more_results_needed?
+    @options[:limit].present? && @query['result'].count < @options[:limit]
+  end
+  
+  def get_more
+    offset = @query['result'].count
+    new_limit = @options[:limit] - offset
+    get('query', :query => query_string(:limit => "#{offset}, #{new_limit}"))['result']
+  end
+end

data/lib/v_tiger/version.rb

@@ -0,0 +1,3 @@
+class VTiger
+  VERSION = "0.0.1.3"
+end

data/lib/v_tiger.rb

@@ -0,0 +1,46 @@
+require "v_tiger/version"
+require "v_tiger/api"
+# require "vtiger/query"
+
+require 'httparty'
+require 'json'
+YAML::ENGINE.yamler = "syck"
+
+require 'active_support/time'
+require 'active_support/core_ext/numeric'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/hash/slice'
+
+class VTiger
+  cattr_accessor :user, :key, :uri
+  include VTiger::API
+  # include VTiger::Query
+  
+  def self.config(config = {})
+    VTiger.user = config[:user]
+    VTiger.key  = config[:key]
+    VTiger.uri  = config[:uri]
+  end
+  
+  def get(operation, query = {})
+    query = {:operation => operation, :sessionName => VTiger.session}.merge(query)
+    HTTParty.get(VTiger.uri, :query => query).parsed_response
+  end
+  
+  def post(operation, body = {})
+    body = {:operation => operation, :sessionName => VTiger.session}.merge(body)
+    HTTParty.post(VTiger.uri, :body => body).parsed_response
+  end
+  
+  private
+  
+    def self.session
+      unless @session && @challenge['expireTime'] > 30.seconds.from_now.to_i
+        @challenge  = HTTParty.get(uri, :query => {:operation => 'getchallenge', :username => user}).parsed_response['result']
+        digest      = "#{@challenge['token']}#{key}"
+        access_key  = Digest::MD5.hexdigest(digest)
+        @session    = HTTParty.post(uri, {:body => {:operation => 'login', :username => user, :accessKey => access_key}}).parsed_response['result']['sessionName']
+      end
+      @session
+    end
+end

data/spec/product_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "Product" do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'v_tiger' # and any other gems you need
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/support/include_hash.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :include_hash do |expected|
+
+  match do |actual|
+    actual.present? && actual.slice(*expected.keys) == expected
+  end
+
+end

data/spec/vtiger_query_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "VTiger::Query" do
+  before(:all) do 
+    VTiger.config(:user => 'admin', :key  => 'dH1WLzo4utYOpXx9', :uri  => 'http://crm.ihswebdesign.com/webservice.php')
+    @api = VTiger.new
+  end
+  describe "#query" do
+    context "with just the objectType " do
+      before(:all) do
+        @query = @api.query('Products')
+      end
+      it "should return somthing" do
+        @query['result'].should be
+      end
+      
+      it "should default to 100 objects" do
+        @query['result'].count.should equal(100)
+      end
+    end
+    
+    context "with a limit" do
+      it "should not return more than the limit" do
+        @api.query('Products', :limit => 50)['result'].count.should_not > 50
+      end
+      
+      it "should return more than 100 is more than default" do
+        @api.query('Products', :limit => 150)['result'].count.should > 100
+      end
+    end
+  end
+end

data/spec/vtiger_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe "VTiger" do
+  before(:all) do 
+    VTiger.config(:user => 'admin', :key  => 'dH1WLzo4utYOpXx9', :uri  => 'http://crm.ihswebdesign.com/webservice.php')
+    @api = VTiger.new
+  end
+  describe ".config" do
+    context "should set user, key, and uri class variables" do
+      it "user is admin" do
+        VTiger.user.should == 'admin'
+      end
+      
+      it "key is dH1WLzo4utYOpXx9" do
+        VTiger.key.should == 'dH1WLzo4utYOpXx9'
+      end
+      
+      it "uri is http://crm.ihswebdesign.com/webservice.php" do
+        VTiger.uri.should == 'http://crm.ihswebdesign.com/webservice.php'
+      end
+    end
+  end
+
+  describe "#create" do
+    context " with a valid object" do
+      before(:all) do
+        @attributes = {'productname' => 'Title of Product', 'manufacturer' => 'Broyhill'}
+        @create = @api.create('Products', @attributes)
+      end
+      it "should return success" do
+        @create['success'].should be_true
+      end
+    
+      it "should return an VTigerObject that matches what we sent" do
+        @create['result'].should include_hash(@attributes)
+      end
+    end
+  end
+  
+  describe "#retrieve" do
+    context " with a valid object" do
+      before(:all) do
+        @attributes = {'productname' => 'Title of Product', 'manufacturer' => 'Broyhill'}
+        id = @api.create('Products', @attributes)['result']['id']
+        @retrieve = @api.retrieve(id)
+      end
+      it "should return success" do
+        @retrieve['success'].should be_true
+      end
+    
+      it "should return an VTigerObject that matches what we sent" do
+        @retrieve['result'].should include_hash(@attributes)
+      end
+    end
+  end
+  
+  describe "#query" do
+    before(:all) do
+      @query = @api.query('select * from Products;')
+    end
+    it "should return success" do
+      @query['success'].should be_true
+    end
+    
+    it "should return an array of objects" do
+      @query['result'].should be_a(Array)
+    end
+  end
+  
+  describe "#list_types" do
+    it "should include Products" do
+      @api.list_types.should include('Products')
+    end
+  end
+  
+  describe "#describe" do
+    context " Product" do
+      it "should have a label with Products" do
+        @api.describe('Products')['label'].should == "Products"
+      end
+    end
+    
+  end
+  
+  describe ".session" do
+    it "should be present" do
+      VTiger.class_eval{session}.should be
+    end
+    
+    it "should persist" do
+      VTiger.class_eval{session}.should == VTiger.class_eval{session}
+    end
+  end
+end

data/v_tiger.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "v_tiger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "v_tiger"
+  s.version     = VTiger::VERSION
+  s.authors     = ["Torey Heinz"]
+  s.email       = ["torey@ihswebdesign.com"]
+  s.homepage    = ""
+  s.summary     = %q{A very Thin wrapper around the VTiger Web Services API}
+  s.description = %q{A very Thin wrapper around the VTiger Web Services API}
+
+  s.rubyforge_project = "v_tiger"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('httparty')
+  s.add_dependency('activesupport')
+  s.add_dependency('i18n')
+  
+  s.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: v_tiger
+version: !ruby/object:Gem::Version
+  version: 0.0.1.3
+  prerelease: 
+platform: ruby
+authors:
+- Torey Heinz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70336370116520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70336370116520
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70336370116100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70336370116100
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70336364465500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70336364465500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70336364465080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336364465080
+description: A very Thin wrapper around the VTiger Web Services API
+email:
+- torey@ihswebdesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- Rakefile
+- lib/v_tiger.rb
+- lib/v_tiger/api.rb
+- lib/v_tiger/query.rb
+- lib/v_tiger/version.rb
+- spec/product_spec.rb
+- spec/spec_helper.rb
+- spec/support/include_hash.rb
+- spec/vtiger_query_spec.rb
+- spec/vtiger_spec.rb
+- v_tiger.gemspec
+homepage: ''
+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: v_tiger
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A very Thin wrapper around the VTiger Web Services API
+test_files:
+- spec/product_spec.rb
+- spec/spec_helper.rb
+- spec/support/include_hash.rb
+- spec/vtiger_query_spec.rb
+- spec/vtiger_spec.rb