method_crm 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Torey Heinz
+
+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,59 @@
+# MethodCrm
+
+A ruby wrapper for the MethodCRM API
+
+A complete list of service methods can be found here: [https://www.methodintegration.com/MethodAPI/service.asmx](https://www.methodintegration.com/MethodAPI/service.asmx). For this gem the V2 version of methods is assumed.
+
+## Usage
+
+    client = MethodClient.new('Company', 'username', 'P@SSw0rd')
+
+    client.table_list
+     => ["Account", "AccountAccountType", ... "VendorCreditLineItem", "VendorType"]
+
+    client.table_list(:detailed)
+     => [
+          [  0] {
+                 "TableName" => "Account",
+               "SupportsAdd" => "true",
+              "SupportsEdit" => "true"
+          },
+          [  1] {
+                 "TableName" => "AccountAccountType",
+               "SupportsAdd" => "false",
+              "SupportsEdit" => "false"
+          },
+          ...
+          [155] {
+                 "TableName" => "VendorCreditLineItem",
+               "SupportsAdd" => "true",
+              "SupportsEdit" => "true"
+          },
+          [156] {
+                 "TableName" => "VendorType",
+               "SupportsAdd" => "true",
+              "SupportsEdit" => "false"
+          }
+        ]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'method_crm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_crm
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/method_crm.rb

@@ -0,0 +1,33 @@
+require 'rest_client'
+require 'multi_xml'
+module MethodCrm
+  class Client
+
+    def initialize(company, username, password)
+      @auth = {strCompanyAccount: company, strLogin: username, strPassword:  password, strSessionID: nil}
+    end
+
+    def table_list
+      parsed_response('TableList')
+    end
+
+    def field_list(table)
+      parsed_response('FieldList', {'strTable' => table})
+    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})
+      parsed_response('Select_XML', data)
+    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']
+    end
+  end
+end

data/method_crm.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "method_crm"
+  gem.version       = '0.0.1'
+  
+  gem.author        = 'Torey Heinz'
+  gem.email         = 'toreyheinz@gmail.com'
+  gem.description   = %q{A ruby wrapper for the MethodCRM API}
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/toreyheinz/method_crm'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.require_path  = 'lib'
+
+  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.test_files    = gem.files.grep(/^spec/)
+end

data/spec/method_crm_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe MethodCrm::Client do
+  let(:client) {MethodCrm::Client.new(CONFIG[:company], CONFIG[:user], CONFIG[:password])}
+
+  it '#table_list returns an array of table hashes' do
+    client.table_list.all? {|hash| hash.has_key?('TableName')}.should be
+  end
+
+  it '#field_list returns an array of field hashes' do
+    client.field_list('Invoice').all? {|hash| hash.has_key?('FieldName')}.should be
+  end
+
+  it '#get_records returns a table`s records' do
+    client.get_records('Account').all? {|hash| hash.has_key?('AccountNumber')}.should be
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'method_crm'
+CONFIG = YAML.load_file(File.expand_path('../support/config.yml', __FILE__))
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each{|f| require f }

data/spec/support/config.example.yml

@@ -0,0 +1,3 @@
+:company: Company
+:user: admin
+:password: P@SSw0rd

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: method_crm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Torey Heinz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: A ruby wrapper for the MethodCRM API
+email: toreyheinz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/method_crm.rb
+- method_crm.gemspec
+- spec/method_crm_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.example.yml
+homepage: https://github.com/toreyheinz/method_crm
+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'
+      segments:
+      - 0
+      hash: 2400250086319970818
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2400250086319970818
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the MethodCRM API
+test_files:
+- spec/method_crm_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.example.yml