method_crm 0.0.1 → 0.1.0

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-spec/support/config.yml
+spec/support/config.yml
+spec/support/cassettes/MethodCrm_Client.yml

data/.rspec

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

data/lib/method_crm.rb

@@ -1,5 +1,7 @@
 require 'rest_client'
 require 'multi_xml'
+
+class MethodCrmClientError < StandardError; end
 module MethodCrm
   class Client
 
@@ -7,27 +9,53 @@ module MethodCrm
       @auth = {strCompanyAccount: company, strLogin: username, strPassword:  password, strSessionID: nil}
     end
 
-    def table_list
-      parsed_response('TableList')
+    def table_list(output = nil)
+      results = parsed_response('TableList')
+      case output.to_s
+      when 'detailed'
+        results
+      else
+        results.map { |table| table['TableName'] }
+      end
     end
 
-    def field_list(table)
-      parsed_response('FieldList', {'strTable' => table})
+    def field_list(table, output = nil) 
+      results = parsed_response('FieldList', {'strTable' => table})
+      case output.to_s
+      when 'detailed'
+        results
+      else
+        results.map { |table| table['FieldName'] }
+      end
     end
 
-    def get_records(table, fields = :all_fields)
-      if fields == :all_fields
-        fields = field_list(table).map { |field| field['FieldName'] }.join(',')
-      end
-      data = @auth.merge({strTable: table, strFields: fields, strWhereClause: nil, strGroupByClause: nil, strHaving: nil, strOrderBy: nil})
+    def get_records(table, options={})
+      options[:fields] ||= field_list(table).join(',')
+      options = {:where => nil}.merge(options)
+      data = @auth.merge({strTable: table, strFields: options[:fields], strWhereClause: options[:where], strGroupByClause: nil, strHaving: nil, strOrderBy: nil})
       parsed_response('Select_XML', data)
     end
 
+    def get_record(table, options={})
+      record = get_records(table, options)
+      raise MethodCrmClientError, 'Query returned more than one record' unless record.is_a?(Hash)
+      record
+    end
   private
     def parsed_response(opperation, data={})
       result = RestClient.post("http://www.methodintegration.com/MethodAPI/service.asmx/MethodAPI#{opperation}V2", @auth.merge(data))
-      content = MultiXml.parse(result)['string']['__content__']
-      MultiXml.parse(content)['MethodAPI']['MethodIntegration']['Record']
+      xml    = MultiXml.parse(result)
+      content = xml['string']['__content__'] || xml['string']
+      parsed_content = MultiXml.parse(content)
+      if parsed_content['MethodAPI']['response'] == "Success"
+        unless parsed_content['MethodAPI']['MethodIntegration'].nil?
+          parsed_content['MethodAPI']['MethodIntegration']['Record']
+        else
+          []
+        end
+      else
+        raise MethodCrmClientError, parsed_content['MethodAPI']['response']
+      end
     end
   end
 end

data/method_crm.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "method_crm"
-  gem.version       = '0.0.1'
+  gem.version       = '0.1.0'
   
   gem.author        = 'Torey Heinz'
   gem.email         = 'toreyheinz@gmail.com'
@@ -15,7 +15,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rest-client', '~> 1.6'
   gem.add_dependency 'multi_xml'
 
-  gem.add_development_dependency 'rake', '~> 0.9'
-  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_development_dependency 'rake',    '~> 0.9'
+  gem.add_development_dependency 'rspec',   '~> 2.12'
+  gem.add_development_dependency 'vcr',     '~> 1.6.0'
+  gem.add_development_dependency 'webmock', '~> 1.6.0'
   gem.test_files    = gem.files.grep(/^spec/)
 end

data/spec/method_crm_spec.rb

@@ -1,17 +1,115 @@
 require 'spec_helper'
 
 describe MethodCrm::Client do
-  let(:client) {MethodCrm::Client.new(CONFIG[:company], CONFIG[:user], CONFIG[:password])}
+  let(:client) {MethodCrm::Client.new(
+    CONFIG[:company],
+    CONFIG[:user],
+    CONFIG[:password]
+    )}
+  use_vcr_cassette
 
-  it '#table_list returns an array of table hashes' do
-    client.table_list.all? {|hash| hash.has_key?('TableName')}.should be
+  describe '#table_list' do
+    it 'returns a list of table names' do
+      results = client.table_list
+      results.should include(
+        "Account",
+        "AccountAccountType",
+        "VendorCreditLineItem",
+        "VendorType"
+        )
+    end
+
+    context ":detailed" do
+      it 'returns a list of table details' do
+        results = client.table_list(:detailed)
+        results.first.keys.should include(
+            'TableName',
+            'SupportsAdd',
+            'SupportsEdit'
+          )
+      end
+    end
   end
 
-  it '#field_list returns an array of field hashes' do
-    client.field_list('Invoice').all? {|hash| hash.has_key?('FieldName')}.should be
+  describe '#field_list' do
+    it 'returns a given table`s field names' do
+      results = client.field_list('AccountAccountType')
+      results.should include("AccountTypeName", "RecordID")
+    end
+
+    context ":detailed" do
+      it 'returns a given table`s field details' do
+        results = client.field_list('AccountAccountType', :detailed)
+        results.first.keys.should include(
+          "SupportsAdd",
+          "SupportsEdit",
+          "IsRequired",
+          "FieldName",
+          "MaxSize",
+          "DataType"
+          )
+      end
+    end
   end
 
-  it '#get_records returns a table`s records' do
-    client.get_records('Account').all? {|hash| hash.has_key?('AccountNumber')}.should be
+  describe '#get_records' do
+    it 'returns a given table`s records' do
+      results = client.get_records('AccountAccountType')
+      results.map {|record| record['AccountTypeName'] }.should include(
+          "AccountsPayable",
+          "AccountsReceivable",
+          "Bank",
+          "CostOfGoodsSold",
+          "CreditCard",
+          "Equity",
+          "Expense",
+          "FixedAsset",
+          "Income",
+          "LongTermLiability", 
+          "NonPosting", 
+          "OtherAsset", 
+          "OtherCurrentAsset", 
+          "OtherCurrentLiability", 
+          "OtherExpense", 
+          "OtherIncome", 
+          "Suspense"
+        )
+    end
+
+    it 'limits records with a where clause' do
+      results = client.get_records('AccountAccountType', {:where => "AccountTypeName like 'Other%'"})
+      account_type_names = results.map {|record| record['AccountTypeName'] }
+      account_type_names.should include(
+          "OtherAsset", 
+          "OtherCurrentAsset", 
+          "OtherCurrentLiability", 
+          "OtherExpense", 
+          "OtherIncome", 
+        )
+      account_type_names.should_not include(
+          "AccountsPayable",
+          "Suspense"
+        )
+    end
+
+    it 'returns an empty Array when no records are found' do
+      results = client.get_records('AccountAccountType', {:where => "AccountTypeName like 'SomeNonExistingName!'"})
+      results.should eq([])
+    end
+  end
+
+  describe '#get_record' do
+    it "returns a single record" do
+      result = client.get_record('AccountAccountType', {:where => "AccountTypeName like 'CostOfGoodsSold'"})
+      result['AccountTypeName'].should eq('CostOfGoodsSold')
+    end
+
+    it "raises an error if more than one record is found" do
+      expect {
+        client.get_record('AccountAccountType', 
+          {:where => "AccountTypeName like 'Other%'"}
+          )
+        }.to raise_error(MethodCrmClientError, 'Query returned more than one record')
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,19 @@
+require 'bundler/setup'
 require 'method_crm'
+require 'vcr'
+
 CONFIG = YAML.load_file(File.expand_path('../support/config.yml', __FILE__))
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each{|f| require f }
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end
 
-Dir[File.expand_path('../support/**/*.rb', __FILE__)].each{|f| require f }
+VCR.config do |c|
+  c.default_cassette_options = { 
+    :record => :new_episodes,
+    :match_requests_on => [:method, :uri, :body]
+  }
+  c.stub_with :webmock
+  c.cassette_library_dir = 'spec/support/cassettes'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_crm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,39 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 description: A ruby wrapper for the MethodCRM API
 email: toreyheinz@gmail.com
 executables: []
@@ -82,6 +114,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -105,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2400250086319970818
+      hash: -2740670062730519801
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -114,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2400250086319970818
+      hash: -2740670062730519801
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24