solve360 0.0.3 → 0.0.4

data/README.markdown

@@ -41,17 +41,17 @@ And if you're using environments like Rails:
 
 Base attributes are set up for you.  Creating is simple:
 
-    Solve360::Contact.create("First Name" => "Stephen", "Last Name" => "Bartholomew")
+    Solve360::Contact.create(:fields => "First Name" => "Stephen", "Last Name" => "Bartholomew")
     
 Custom attributes can be added:
 
-    Solve360::Contact.fields do
+    Solve360::Contact.map_fields do
       {"Description" => "custom20394", "Location" => "custom392434"}
     end
 
 and then used:
 
-    contact = Solve360::Contact.create("First Name" => "Steve", "Description" => "Web Developer", "Location" => "England")
+    contact = Solve360::Contact.create(:fields => "First Name" => "Steve", "Description" => "Web Developer", "Location" => "England")
     contact.id
     => The ID of the record created on the CRM
     
@@ -65,11 +65,23 @@ You can find by the ID of a record on the CRM:
 
 Once you have set the attributes on a model you can simply save:
 
-    contact.attributes["First Name"] = "Steve"
+    contact.fields["First Name"] = "Steve"
     contact.save
 
 If the record does not have an ID it'll be created, otherwise the details will be saved.
 
+### Related Items
+
+Related items can be access via:
+  
+    contact.related_items
+    => {"name" => "Curve21", "id" => "12345"}
+
+And added:
+
+    contact.add_related_item({"name" => "ACME Ltd", "id" => "91284"})
+    contact.save
+    
 ## Support/Bugs
 
 [Lighthouse](http://c21.lighthouseapp.com/projects/38966-solve360/overview)

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/solve360.rb

@@ -4,6 +4,6 @@ require "active_support/inflector"
 require "active_support/core_ext/hash"
 
 
-["model", "config", "contact", "company"].each do |lib|
+["item", "config", "contact", "company"].each do |lib|
   require File.join(File.dirname(__FILE__), "solve360", lib)
 end

data/lib/solve360/company.rb

@@ -1,8 +1,8 @@
 module Solve360
   class Company
-    include Solve360::Model
+    include Solve360::Item
     
-    fields do
+    map_fields do
       {"Billing Address" => "billingaddress", 
       "Company Address" => "mainaddress", 
       "Company Fax" => "fax", 

data/lib/solve360/contact.rb

@@ -1,8 +1,8 @@
 module Solve360
   class Contact
-    include Solve360::Model
+    include Solve360::Item
     
-    fields do 
+    map_fields do 
       {"Business Address" => "businessaddress",
       "Business Direct" => "businessphonedirect",
       "Business Email" => "businessemail",

data/lib/solve360/item.rb

@@ -0,0 +1,189 @@
+module Solve360
+  module Item
+    
+    def self.included(model)
+      model.extend ClassMethods
+      model.send(:include, HTTParty)
+      model.instance_variable_set(:@field_mapping, {})
+    end
+    
+    # Base Item fields
+    attr_accessor :id, :name, :typeid, :created, :updated, :viewed, :ownership, :flagged
+    
+    # Base item collections
+    attr_accessor :fields, :related_items, :related_items_to_add
+    
+    def initialize(attributes = {})
+      attributes.symbolize_keys!
+      
+      self.fields = {}
+      self.related_items = []
+      self.related_items_to_add = []
+      
+      [:fields, :related_items].each do |collection|
+        self.send("#{collection}=", attributes[collection]) if attributes[collection]
+        attributes.delete collection
+      end
+
+      attributes.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+    
+    # @see Base::map_human_attributes
+    def map_human_fields
+      self.class.map_human_fields(self.fields)
+    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
+      response = []
+      if new_record?
+        response = self.class.request(:post, "/#{self.class.resource_name}", to_request)
+        self.id = response["response"]["item"]["id"]
+      else
+        response = self.class.request(:put, "/#{self.class.resource_name}/#{id}", to_request)
+      end
+      
+      related_items.concat(related_items_to_add)
+      
+      response
+    end
+    
+    def new_record?
+      self.id == nil
+    end
+    
+    def to_request
+      xml = "<request>"
+      
+      xml << map_human_fields.collect {|key, value| "<#{key}>#{value}</#{key}>"}.join("")
+      
+      if related_items_to_add.size > 0
+        xml << "<relateditems>"
+        
+        related_items_to_add.each do |related_item|
+          xml << %Q{<add><relatedto><id>#{related_item["id"]}</id></relatedto></add>}
+        end
+        
+        xml << "</relateditems>"
+      end
+      xml << "</request>"
+      
+      xml
+    end
+    
+    def add_related_item(item)
+      related_items_to_add << item
+    end
+    
+    module ClassMethods
+    
+      # Map human map_human_fields to API fields
+      # 
+      # @param [Hash] human mapped fields
+      # @example
+      #   map_attributes("First Name" => "Steve", "Description" => "Web Developer")
+      #   => {:firstname => "Steve", :custom12345 => "Web Developer"}
+      # 
+      # @return [Hash] API mapped attributes
+      #
+      def map_human_fields(fields)
+        mapped_fields = {}
+
+        field_mapping.each do |human, api|
+          mapped_fields[api] = fields[human] if !fields[human].blank?
+        end
+
+        mapped_fields
+      end
+      
+      # As ::map_api_fields 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_fields(fields)
+        fields.stringify_keys!
+        
+        mapped_fields = {}
+
+        field_mapping.each do |human, api|
+          mapped_fields[human] = fields[api] if !fields[api].blank?
+        end
+        
+        mapped_fields
+      end
+      
+      # Create a record in the API
+      #
+      # @param [Hash] field => value as configured in Item::fields
+      def create(fields, options = {})
+        new_record = self.new(fields)
+        new_record.save
+        new_record
+      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)
+        item = response["response"]["item"]
+        item.symbolize_keys!
+        
+        item[:fields] = map_api_fields(item[:fields])
+      
+        record = new(item)
+        
+        if response["response"]["relateditems"]
+          related_items = response["response"]["relateditems"]["relatedto"]
+        
+          if related_items.kind_of?(Array)
+            record.related_items.concat(related_items)
+          else
+            record.related_items = [related_items]
+          end
+        end
+        
+        record
+      end
+      
+      def resource_name
+        self.name.to_s.demodulize.underscore.pluralize
+      end
+
+      def map_fields(&block)        
+        @field_mapping.merge! yield
+      end
+      
+      def field_mapping
+        @field_mapping
+      end
+    end
+  end
+end

data/spec/solve360/item_spec.rb

@@ -0,0 +1,161 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+class Person
+  include Solve360::Item
+  
+  map_fields do
+    { "Job Title" => "job_title", "Name" => "name" }
+  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::Item
+        map_fields do
+          { "Doors" => "doors" }
+        end
+      end
+      
+      Car.field_mapping.keys.include?("Job Title").should be_false
+      Person.field_mapping.keys.include?("Doors").should be_false
+    end
+  end
+  
+  context "XML respresentation" do
+    before do
+      @person = Person.new(:fields => {"Name" => "Stephen"})
+      @person.add_related_item({"name" => "Curve21", "id" => "12345"})
+      
+      @xml = Crack::XML.parse(@person.to_request)
+    end
+    
+    it "should contain related items to add" do
+      @xml["request"]["relateditems"]["add"]["relatedto"]["id"].should == "12345"
+    end
+    
+    it "should contain item fields" do
+      @xml["request"]["name"].should == "Stephen"
+    end
+  end
+end
+
+describe "Field mapping" do
+  before do
+    Person.map_fields do 
+      {"Interests"	=> "custom_interests",
+      "Department Website" => "custom_deptwebsite",
+      "Description" => "custom_description"}
+    end
+    
+    @person = Person.new
+  end
+  
+  it "should set base map" do
+    Person.field_mapping["Job Title"].should == "job_title"
+  end
+  
+  it "should set custom map" do
+    Person.field_mapping["Interests"].should == "custom_interests"
+  end
+  
+  it "should allow setting of values on an instance via field maps" do
+    @person.fields["Interests"] = "Coding"
+    @person.fields["Interests"].should == "Coding"
+  end
+  
+  it "should map human fields to API fields" do
+    fields = {"Description" => "A description"}
+    
+    Person.map_human_fields(fields)["custom_description"].should == "A description"
+  end
+  
+  it "should map API fields to human fields" do
+    fields = {:custom_description => "A description"}
+    
+    Person.map_api_fields(fields)["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(:fields => {"First Name" => "Catherine"})
+    end
+  
+    it "should be valid" do
+      @contact.fields["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(:fields => {"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.fields["First Name"].should == "Henry"
+      @contact.id.should == "12345"
+    end
+    
+    it "should have relations" do
+      @contact.related_items.first["name"].should == "Curve21"
+    end
+  end
+end
+
+describe "Updating a record" do
+  before do
+    @contact = Solve360::Contact.new(:fields => {"First Name" => "Steve"})
+
+    @contact.id = "12345"
+    
+    stub_http_response_with("contacts/update-success.json")
+    
+    @contact.fields["First Name"] = "Steve"
+    
+    @response = @contact.save
+  end
+  
+  it "should be valid" do
+    @response["response"]["status"].should == "success"
+  end
+end
+
+describe "Adding a releated item" do
+  before do 
+    @contact = Solve360::Contact.new(:fields => {"First Name" => "Steve"})
+    @contact.id = "12345"
+    
+    stub_http_response_with("contacts/update-success.json")
+    
+    @contact.add_related_item({"name" => "A New Company", "id" => "932334"})
+    @contact.save
+  end
+  
+  it "should become set after save" do
+    @contact.related_items.first["name"].should == "A New Company"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: solve360
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Stephen Bartholomew
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-16 00:00:00 +01:00
+date: 2009-10-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,7 +59,7 @@ files:
 - lib/solve360/company.rb
 - lib/solve360/config.rb
 - lib/solve360/contact.rb
-- lib/solve360/model.rb
+- lib/solve360/item.rb
 - spec/api_settings.yml
 - spec/api_settings.yml.sample
 - spec/fixtures/contacts/create-success.json
@@ -69,7 +69,7 @@ files:
 - spec/fixtures/contacts/show-success.json
 - spec/fixtures/contacts/update-failed.json
 - spec/fixtures/contacts/update-success.json
-- spec/solve360/model_spec.rb
+- spec/solve360/item_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -101,5 +101,5 @@ signing_key:
 specification_version: 3
 summary: Libary for working with the Solve360 CRM API
 test_files: 
-- spec/solve360/model_spec.rb
+- spec/solve360/item_spec.rb
 - spec/spec_helper.rb

data/lib/solve360/model.rb

@@ -1,141 +0,0 @@
-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/solve360/model_spec.rb

@@ -1,128 +0,0 @@
-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