solve360 0.0.3

data/NOTES

@@ -0,0 +1,23 @@
+:assignedto
+:background
+:businessaddress
+:businessphonedirect
+:businessemail
+:businessfax
+:businessphonemain
+:cellularphone
+:custom854308
+:custom854310
+:custom854311
+:custom854307
+:businessphoneextension
+:firstname
+:homephone
+:homeaddress
+:custom854309
+:jobtitle
+:lastname
+:personalemail
+:relatedto
+:custom854312
+:website 

data/README.markdown

@@ -0,0 +1,75 @@
+# Solve360
+
+Library for interacting with Norada's Solve360 CRM
+
+http://norada.com/
+
+## Usage
+
+### Installing
+  
+The gem is hosted on [Gem Cutter](http://gemcutter.org):
+
+    gem sources -a http://gemcutter.org
+    gem install solve360
+
+### Configuration
+
+You can configure the API settings in a number of ways, but you must specify:
+
+* url
+* username
+* token
+
+The configuration uses [Configify](http://github.com/curve21/configify) so you can use a block or hash to define values:
+
+    Solve360::Config.configure do |config|
+      config.url = "https://secure.solve360.com"
+      config.username = "user@user.com"
+      config.token = "token"
+    end
+
+Because configure accepts a hash, you can configure with YAML:
+
+    Solve360::Config.configure YAML.load(File.read("/path/to/file"))
+
+And if you're using environments like Rails:
+
+    Solve360::Config.configure YAML.load(File.read("/path/to/file"))[RAILS_ENV]
+
+### Creating Records
+
+Base attributes are set up for you.  Creating is simple:
+
+    Solve360::Contact.create("First Name" => "Stephen", "Last Name" => "Bartholomew")
+    
+Custom attributes can be added:
+
+    Solve360::Contact.fields do
+      {"Description" => "custom20394", "Location" => "custom392434"}
+    end
+
+and then used:
+
+    contact = Solve360::Contact.create("First Name" => "Steve", "Description" => "Web Developer", "Location" => "England")
+    contact.id
+    => The ID of the record created on the CRM
+    
+### Finding
+
+You can find by the ID of a record on the CRM:
+
+    contact = Solve360::Contact.find(12345)
+
+### Saving
+
+Once you have set the attributes on a model you can simply save:
+
+    contact.attributes["First Name"] = "Steve"
+    contact.save
+
+If the record does not have an ID it'll be created, otherwise the details will be saved.
+
+## Support/Bugs
+
+[Lighthouse](http://c21.lighthouseapp.com/projects/38966-solve360/overview)

data/Rakefile

@@ -0,0 +1,40 @@
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "solve360"
+    gem.summary = "Libary for working with the Solve360 CRM API"
+    gem.email = "Stephen Bartholomew"
+    gem.homepage = "http://github.com/curve21/solve360"
+    gem.description = ""
+    gem.authors = ["Stephen Bartholomew"]
+    gem.files =  FileList["[A-Z]*", "{lib,spec}/**/*"]
+    gem.add_dependency("configify", ">=0.0.1")
+    gem.add_dependency("activesupport")  
+    gem.add_dependency("httparty", ">=0.4.5")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+Spec::Rake::SpecTask.new(:coverage) do |spec|
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'examples']
+end
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ["lib/**/*.rb"]
+  end
+rescue LoadError
+  puts "You'll need yard to generate documentation: gem install yard"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/solve360.rb

@@ -0,0 +1,9 @@
+require "httparty"
+require "configify"
+require "active_support/inflector"
+require "active_support/core_ext/hash"
+
+
+["model", "config", "contact", "company"].each do |lib|
+  require File.join(File.dirname(__FILE__), "solve360", lib)
+end

data/lib/solve360/company.rb

@@ -0,0 +1,16 @@
+module Solve360
+  class Company
+    include Solve360::Model
+    
+    fields do
+      {"Billing Address" => "billingaddress", 
+      "Company Address" => "mainaddress", 
+      "Company Fax" => "fax", 
+      "Company Name" => "name", 
+      "Company Phone" => "phone", 
+      "Related To" => "relatedto", 
+      "Shipping Address" => "shippingaddress", 
+      "Website" => "website"}
+    end
+  end
+end

data/lib/solve360/config.rb

@@ -0,0 +1,5 @@
+module Solve360
+  class Config
+    include Configify::Config
+  end
+end

data/lib/solve360/contact.rb

@@ -0,0 +1,23 @@
+module Solve360
+  class Contact
+    include Solve360::Model
+    
+    fields do 
+      {"Business Address" => "businessaddress",
+      "Business Direct" => "businessphonedirect",
+      "Business Email" => "businessemail",
+      "Business Fax" => "businessfax",
+      "Business Main" => "businessphonemain",
+      "Cellular" => "cellularphone",
+      "Extension" => "businessphoneextension",
+      "First Name" => "firstname",
+      "Home" => "homephone",
+      "Home Address" => "homeaddress",
+      "Job Title" => "jobtitle",
+      "Last Name" => "lastname",
+      "Personal Email" => "personalemail",
+      "Related To" => "relatedto",
+      "Website" => "website"}
+    end
+  end
+end

data/lib/solve360/model.rb

@@ -0,0 +1,141 @@
+module Solve360
+  module Model
+    
+    def self.included(model)
+      model.extend ClassMethods
+      model.send(:include, HTTParty)
+      model.instance_variable_set(:@fields, {})
+    end
+    
+    attr_accessor :attributes, :id, :relations
+    
+    def initialize(attributes = {})
+      self.attributes = attributes
+      self.relations = []
+      self.id = nil
+    end
+    
+    # @see Base::map_human_attributes
+    def map_human_attributes
+      self.class.map_human_attributes(self.attributes)
+    end
+    
+    # Save the attributes for the current record to the CRM
+    #
+    # If the record is new it will be created on the CRM
+    # 
+    # @return [Hash] response values from API
+    def save
+      if new_record?
+        new_record = self.class.create(attributes)
+        self.id = new_record.id
+      else
+        self.class.request(:put, "/#{self.class.resource_name}/#{id}", map_human_attributes.to_xml(:root => "request"))
+      end
+    end
+    
+    def new_record?
+      self.id == nil
+    end
+
+    module ClassMethods
+    
+      # Map human attributes to API attributes
+      # 
+      # @param [Hash] human mapped attributes
+      # @example
+      #   map_attributes("First Name" => "Steve", "Description" => "Web Developer")
+      #   => {:firstname => "Steve", :custom12345 => "Web Developer"}
+      # 
+      # @return [Hash] API mapped attributes
+      #
+      def map_human_attributes(attributes)
+        mapped_attributes = {}
+
+        fields.each do |human, api|
+          mapped_attributes[api] = attributes[human] if !attributes[human].blank?
+        end
+
+        mapped_attributes
+      end
+      
+      # As ::map_human_attributes but API -> human
+      #
+      # @param [Hash] API mapped attributes
+      # @example
+      #   map_attributes(:firstname => "Steve", :custom12345 => "Web Developer")
+      #   => {"First Name" => "Steve", "Description" => "Web Developer"}
+      #
+      # @return [Hash] human mapped attributes
+      def map_api_attributes(attributes)
+        attributes.stringify_keys!
+        
+        mapped_attributes = {}
+
+        fields.each do |human, api|
+          mapped_attributes[human] = attributes[api] if !attributes[api].blank?
+        end
+        
+        mapped_attributes
+      end
+      
+      # Create a record in the API
+      #
+      # @param [Hash] field => value as configured in Model::fields
+      def create(attributes, options = {})
+        response = request(:post, "/#{resource_name}", map_human_attributes(attributes).to_xml(:root => "request"))
+              
+        construct_record_from_response(response)
+      end
+      
+      # Find a record 
+      # 
+      # @param [Integer] id of the record on the CRM
+      def find(id)
+        response = request(:get, "/#{resource_name}/#{id}")
+                       
+        construct_record_from_response(response)
+      end
+      
+      # Send an HTTP request
+      # 
+      # @param [Symbol, String] :get, :post, :put or :delete
+      # @param [String] url of the resource 
+      # @param [String, nil] optional string to send in request body
+      def request(verb, uri, body = "")
+        send(verb, HTTParty.normalize_base_uri(Solve360::Config.config.url) + uri,
+            :headers => {"Content-Type" => "application/xml", "Accepts" => "application/json"},
+            :body => body,
+            :basic_auth => {:username => Solve360::Config.config.username, :password => Solve360::Config.config.token})
+      end
+      
+      def construct_record_from_response(response)
+        attributes = map_api_attributes(response["response"]["item"]["fields"])
+        record = new(attributes)
+        
+        related_to = response["response"]["relateditems"]["relatedto"]
+        
+        if related_to.kind_of?(Array)
+          record.relations.concat(related_to)
+        else
+          record.relations << related_to
+        end
+        
+        record.id = response["response"]["item"]["id"].to_i
+        record
+      end
+      
+      def resource_name
+        self.name.to_s.demodulize.underscore.pluralize
+      end
+
+      def fields(&block)        
+        if block_given?
+          @fields.merge! yield
+        else
+          @fields
+        end
+      end
+    end
+  end
+end

data/spec/api_settings.yml

@@ -0,0 +1,3 @@
+url: https://secure.solve360.com
+username: steve@curve21.com
+token: 46a1j9Z9n0seOaLaPa2bne7c563fgds0S0J990g5

data/spec/api_settings.yml.sample

@@ -0,0 +1,3 @@
+url:
+username:
+token

data/spec/fixtures/contacts/create-success.json

@@ -0,0 +1 @@
+{"response" : {"relateditems" : nil, "activities" : nil, "categories" : nil, "status" : "success", "item" : {"name" : "Test ", "typeid" : "1", "id" : "12345", "fields" : {"modificatorid" : "536663", "lastname" : "Bartholomew", "creatorname" : "Stephen Bartholomew", "businessemail" : nil, "modificatorname" : "Stephen Bartholomew", "firstname" : "Catherine", "creatorid" : "536663", "personalemail" : nil}, "viewed" : "2009-10-06T08:15:27+00:00", "ownership" : "536663", "flagged" : nil, "updated" : "2009-10-06T08:15:27+00:00", "created" : "2009-10-06T08:15:27+00:00"}}}

data/spec/fixtures/contacts/find-success.json

@@ -0,0 +1 @@
+{"response" : {"relateditems" : {"relatedto" : {"name" : "Curve21", "typeid" : "40", "id" : "960104", "note" : nil}}, "activities" : nil, "categories" : nil, "status" : "success", "item" : {"name" : "Henry Bartholomew", "typeid" : "1", "id" : "12345", "fields" : {"custom854307" : "A description of Henry", "modificatorid" : "536663", "lastname" : "Bartholomew", "creatorname" : "Stephen Bartholomew", "businessemail" : nil, "modificatorname" : "Stephen Bartholomew", "firstname" : "Henry", "creatorid" : "536663", "personalemail" : nil}, "viewed" : "2009-10-08T09:29:41+00:00", "ownership" : "536663", "flagged" : nil, "updated" : "2009-10-08T09:29:53+00:00", "created" : "2009-10-08T09:28:03+00:00"}}}

data/spec/fixtures/contacts/index.json

@@ -0,0 +1 @@
+{"response" : {"id536666" : {"name" : "Josh Kedward", "id" : "536666", "flagged" : nil, "viewed" : "2009-10-02T14:21:18+00:00", "parentid" : "536663", "updated" : "2009-05-24T10:11:02+00:00", "created" : "2009-05-24T10:10:21+00:00"}, "count" : "2", "id536670" : {"name" : "Stephen Bartholomew", "id" : "536670", "flagged" : nil, "viewed" : "2009-10-02T14:21:18+00:00", "parentid" : "536663", "updated" : "2009-05-24T10:12:32+00:00", "created" : "2009-05-24T10:12:21+00:00"}, "status" : "success"}}

data/spec/fixtures/contacts/show-success.json

@@ -0,0 +1 @@
+{"response" : {"relateditems" : nil, "activities" : nil, "categories" : nil, "status" : "success", "item" : {"name" : "Steve Bartholomew", "typeid" : "1", "id" : "12345", "fields" : {"modificatorid" : "536663", "lastname" : "Bartholomew", "creatorname" : "Stephen Bartholomew", "businessemail" : nil, "modificatorname" : "Stephen Bartholomew", "firstname" : "Henry", "creatorid" : "536663", "personalemail" : nil}, "viewed" : "2009-10-06T10:12:03+00:00", "ownership" : "536663", "flagged" : nil, "updated" : "2009-10-06T10:11:05+00:00", "created" : "2009-10-06T10:08:04+00:00"}}} 

data/spec/fixtures/contacts/update-failed.json

@@ -0,0 +1 @@
+{"response" : {"errors" : {"incorrectfield" : "Incorrect field specified"}, "status" : "failed"}}

data/spec/fixtures/contacts/update-success.json

@@ -0,0 +1 @@
+{"response" : {"status" : "success"}}

data/spec/solve360/model_spec.rb

@@ -0,0 +1,128 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+class Person
+  include Solve360::Model
+  
+  fields do
+    { "Job Title" => "job_title" }
+  end
+end
+
+describe "A Solve360 model" do
+  it "should determine model name" do
+    Person.resource_name.should == "people"
+  end
+  
+  context "more than one model" do
+    it "should not pollute map" do
+      class Car
+        include Solve360::Model
+        fields do
+          { "Doors" => "doors" }
+        end
+      end
+      
+      Car.fields.keys.include?("Job Title").should be_false
+      Person.fields.keys.include?("Doors").should be_false
+    end
+  end
+end
+
+describe "Field mapping" do
+  before do
+    Person.fields do 
+      {"Interests"	=> "custom_interests",
+      "Department Website" => "custom_deptwebsite",
+      "Description" => "custom_description"}
+    end
+    
+    @person = Person.new
+  end
+  
+  it "should set base map" do
+    Person.fields["Job Title"].should == "job_title"
+  end
+  
+  it "should set custom map" do
+    Person.fields["Interests"].should == "custom_interests"
+  end
+  
+  it "should allow setting of values on an instance via field maps" do
+    @person.attributes["Interests"] = "Coding"
+    @person.attributes["Interests"].should == "Coding"
+  end
+  
+  it "should map human map to API map" do
+    attributes = {"Description" => "A description"}
+    
+    Person.map_human_attributes(attributes)["custom_description"].should == "A description"
+  end
+  
+  it "should map API map to human map" do
+    attributes = {:custom_description => "A description"}
+    
+    Person.map_api_attributes(attributes)["Description"].should == "A description"
+  end
+end
+
+describe "Creating a record" do
+  context "directly from create" do
+    before do
+      stub_http_response_with("contacts/create-success.json")
+      @contact = Solve360::Contact.create("First Name" => "Catherine")
+    end
+  
+    it "should be valid" do
+      @contact.attributes["First Name"].should == "Catherine"
+      @contact.id.should == 12345
+    end
+  end
+  
+  context "creating a new object then saving" do
+    before do
+      stub_http_response_with("contacts/create-success.json")
+      @contact = Solve360::Contact.new("First Name" => "Catherine")
+      @contact.save
+    end
+    
+    it "should be valid" do
+      @contact.id.should == 12345
+    end
+  end
+end
+
+describe "Finding a record" do
+  context "Successfully" do
+    before do
+      stub_http_response_with("contacts/find-success.json")
+      @contact = Solve360::Contact.find(12345)
+    end
+  
+    it "should find existing user" do
+      @contact.attributes["First Name"].should == "Henry"
+      @contact.id.should == 12345
+    end
+    
+    it "should have relations" do
+      @contact.relations.first["name"].should == "Curve21"
+    end
+  end
+end
+
+describe "Updating a record" do
+  before do
+    @contact = Solve360::Contact.new("First Name" => "Steve")
+
+    @contact.id = 12345
+    
+    stub_http_response_with("contacts/update-success.json")
+    
+    @contact.attributes["First Name"] = "Steve"
+    
+    @response = @contact.save
+  end
+  
+  it "should be valid" do
+    @response["response"]["status"].should == "success"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'solve360')
+
+Solve360::Config.configure YAML::load(File.read(File.join(File.dirname(__FILE__), 'api_settings.yml')))
+
+def file_fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+end
+ 
+def stub_http_response_with(filename)
+  format = filename.split('.').last.intern
+  data = file_fixture(filename)
+ 
+  response = Net::HTTPOK.new("1.1", 200, "Content for you")
+  response.stub!(:body).and_return(data)
+ 
+  http_request = HTTParty::Request.new(Net::HTTP::Get, 'http://localhost', :format => format)
+  http_request.stub!(:perform_actual_request).and_return(response)
+ 
+  HTTParty::Request.should_receive(:new).and_return(http_request)
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: solve360
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Stephen Bartholomew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: configify
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+description: ""
+email: Stephen Bartholomew
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- NOTES
+- README.markdown
+- Rakefile
+- VERSION
+- lib/solve360.rb
+- lib/solve360/company.rb
+- lib/solve360/config.rb
+- lib/solve360/contact.rb
+- lib/solve360/model.rb
+- spec/api_settings.yml
+- spec/api_settings.yml.sample
+- spec/fixtures/contacts/create-success.json
+- spec/fixtures/contacts/find-company-success.json
+- spec/fixtures/contacts/find-success.json
+- spec/fixtures/contacts/index.json
+- spec/fixtures/contacts/show-success.json
+- spec/fixtures/contacts/update-failed.json
+- spec/fixtures/contacts/update-success.json
+- spec/solve360/model_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/curve21/solve360
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Libary for working with the Solve360 CRM API
+test_files: 
+- spec/solve360/model_spec.rb
+- spec/spec_helper.rb