highrise_wrapper 0.0.2 → 0.0.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzMzODE2ZmYyNDE5OGQwNTRiNDIxN2VhMjY2NjgxYzViZTE3YTNjYw==
+    N2RkZWQ4M2U3YWRjMTg1NzcwMGZkNTZjZjg5NjJjNzUwM2VhMzBmNQ==
   data.tar.gz: !binary |-
-    ZmIyODg2NDg1N2YzNGJkMGVkNmQwMDliNGQxYjYwNDhmZjI3NTc4OQ==
+    Y2JhMGZiYzBmNmM0MzYxMzVkMDI4YTYxOWE5ZDVhMjU3MmU4MmI4OA==
 SHA512:
   metadata.gz: !binary |-
-    OGNjODFlZDc4ZTMzMWQ3ODg4ZDY3ODNlZTc1M2ViMmQwYjIwNjNhZTE5NDll
-    YjIwN2NlZmVhNDkxZTY0YzU0MmIwMjQ3NDU5NmNhNTMyZmYzNzYyZDY3Yjg2
-    ZjdjYzczZGM2Yzg5MzJkN2YxM2E0OTE2MmJjYmY2NTdlMDA5NDI=
+    YWJiNDk5YTcyNTVlY2Q3NzcyOWM3ZjI5ZDY5YjAxZWI4ZWRhMTE0MzE0N2Y0
+    NGRjNmZkNTJlNTBkM2JhYzA2NTAxMmI0MzdmMGZhODFkNjUwMjI3ZDRhODUw
+    ZmNjZTQ3NzBmNDdkMmZhZjI3MmQ0YTViMmM3OWI2NGQwZmQ2Y2U=
   data.tar.gz: !binary |-
-    ZDI2YmY3NGY5NWYwNDIzYTU1YTVmNDhiNzZmYzE5Y2VlNWZlNjM1NzUwOWIz
-    ZjBhYmRiNGM5N2JhYmNhYzI0ZjYxYTQwYmM2ZTkzMGU2NzdlYzRkNzZiMjcw
-    NDVkOGM4OWI3YmFhMmZhZTYwOTI3MjMzMGM1ODNhYjlkYzAzMzQ=
+    MmNkZjIxNDc4NDVjOWQwYTVhMzVjMjZlYWRlMjM3ZGJjM2EyN2Y5ZWM3MjVm
+    MGM4M2FmZGE0NDA4MDRjMGU0NTE1ZTEzYWRlOTc1YjI5MjY0OThlOWZiMTI1
+    YWQ4NzBiNzE1NGZjN2UyZGE0ZWZmNGRkZGUyYmUyNDUxZDY4MWI=

data/README.md

@@ -19,7 +19,63 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can start to use with just a few steps. All you need is to
+have a class including our `Contact` module that:
+
+- implements a `highrise_hash` method that returns a hash with the contact information using the format the highrise_api ( https://github.com/basecamp/highrise-api ) uses
+- has `highrise_token` and `highrise_base_url` available
+
+### Example code
+
+```ruby
+class Contact < ActiveRecord::Base
+  include HighriseWrapper::ActiveRecord
+
+  belongs_to :company
+
+  def fullname
+    "#{first_name} #{last_name}"
+  end
+
+  def highrise_hash
+  {
+    'first_name' => first_name,
+    'last_name' => last_name,
+    'title' => job_title,
+    'company_name' => company_name,
+    'contact_data' =>  {
+      'email_addresses' => [{
+        'address' => email,
+        'location' => 'Work'
+      }],
+      'phone_numbers' => [{
+        'number' => phone,
+        'location' => 'Work'
+      }],
+      'web_addresses' => [{
+        'location' => 'Work',
+        'url' => website
+      }]
+    }
+  }
+  end
+
+  def highrise_token
+    company.highrise_token
+  end
+
+  def highrise_base_url
+    company.highrise_base_url
+  end
+end
+```
+
+### Sample app
+
+There is an example application you can take a look at:
+
+- Source: http://github.com/rhlobo/loboapp
+- Demo: http://loboapp.herokuapp.com
 
 ## Contributing
 

data/TODO

@@ -1,11 +1,11 @@
 MAIN SCOPE:
  ✔ Test integration (highrise gem usage) @done (14-03-20 16:32)
  ✔ Make project read to implementation @done (14-03-20 16:36)
- ☐ ??
- ☐ Criar metodo de conexão com highrise
- ☐ Cadastramento de um contato
- ☐ Descadastramento de um contato
- ☐ Fazer com que chamada a api seja assincrona (outra thread, ou etc)
+ ✔ Experiment with conversion methods @done (14-04-02 18:05)
+ ✔ Criar metodo de conexão com highrise @done (14-04-02 18:05)
+ ✔ Cadastramento de um contato @done (14-04-02 18:06)
+ ✔ Descadastramento de um contato @done (14-04-02 18:06)
+ ✘ Fazer com que chamada a api seja assincrona (outra thread, ou etc) @cancelled (14-04-02 18:06)
  ☐ Remover script de testes
 
 DOCUMENTATION:

data/highrise_wrapper.gemspec

@@ -6,7 +6,7 @@ require 'highrise_wrapper/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "highrise_wrapper"
-  spec.version       = Highrise_wrapper::VERSION
+  spec.version       = HighriseWrapper::VERSION
   spec.authors       = ["rhlobo"]
   spec.email         = ["rhlobo+github@gmail.com"]
   spec.summary       = "Gem to provide easy usage of Highrise API"
@@ -25,8 +25,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 0"
 
-  spec.add_dependency "highrise", "~>3.1"
+  spec.add_dependency "highrise", "~> 3.1.0"
+  #spec.add_dependency "simple_attribute_mapper", "~> 0.0"
+  #spec.add_dependency "virtus", "~> 1.0"
 end

data/lib/highrise_wrapper.rb

@@ -1,5 +1,6 @@
+require 'highrise'
 require "highrise_wrapper/version"
 require "highrise_wrapper/contact"
 
-module Highrise_wrapper
+module HighriseWrapper
 end

data/lib/highrise_wrapper/contact.rb

@@ -1,19 +1,48 @@
-module Highrise_wrapper
+module HighriseWrapper
+  module ActiveRecord
+    def on_highrise?
+      !self.highrise_id.nil?
+    end
 
-  module InstanceMethods
     def highrise_save
-      puts 'Saving'
-      sleep(10.seconds)
+      logger.info 'Saving #{fullname} to highrise'
+
+      begin
+        setup_highrise
+        person = Highrise::Person.new(self.highrise_hash)
+        person.save!
+        self.highrise_id = person.attributes['id']
+        self.save!
+      rescue Exception => exception
+        logger.error(
+          "It was not possible to save contact to highrise: " +
+          "#{exception.class} (#{exception.message})")
+        return false
+      end
     end
 
     def highrise_remove
-      puts 'Removing'
-      sleep(10.seconds)
-    end
+      logger.info 'Removing #{fullname} from highrise'
 
-      def it_works
-        return 42
+      begin
+        setup_highrise
+        person = Highrise::Person.find(highrise_id)
+        person.destroy
+        self.highrise_id = nil
+        self.save!
+      rescue Exception => exception
+        logger.error(
+          "It was not possible to remove contact from highrise: " +
+          "#{exception.class} (#{exception.message})")
+        return false
       end
-  end
+    end
 
+    private
+    def setup_highrise
+        Highrise::Base.site = self.highrise_base_url
+        Highrise::Base.user = self.highrise_token
+        Highrise::Base.format = :xml
+    end
+  end
 end

data/lib/highrise_wrapper/version.rb

@@ -1,3 +1,3 @@
-module Highrise_wrapper
-  VERSION = "0.0.2"
+module HighriseWrapper
+  VERSION = "0.0.9"
 end

data/mytests.rb

@@ -1,74 +1,214 @@
+
 require 'highrise'
+require 'highrise_wrapper'
+
+require 'virtus'
+require 'simple_attribute_mapper'
 
+
+########### highrise setup
 Highrise::Base.site = 'https://personal1788.highrisehq.com'
 Highrise::Base.user = 'ee54dd83345c800c14b6fda0a650659e'
 Highrise::Base.format = :xml
 
 #@people = Highrise::Person.find_all_across_pages(:params => {:tag_id => 12345})
-@people = Highrise::Person.find_all_across_pages
+#@people = Highrise::Person.find_all_across_pages
 
 # [#<Highrise::Person:0x9db1d80 @attributes={"author_id"=>1018065, "background"=>nil, "company_id"=>nil, "created_at"=>2014-03-17 22:11:22 UTC, "first_name"=>"A", "group_id"=>nil, "id"=>201374388, "last_name"=>"A", "owner_id"=>nil, "title"=>nil, "updated_at"=>2014-03-17 22:11:22 UTC, "visible_to"=>"Everyone", "company_name"=>nil, "linkedin_url"=>nil, "avatar_url"=>"http://dge9rmgqjs8m1.cloudfront.net/highrise/missing/avatar.gif?r=3", "contact_data"=>#<Highrise::Person::ContactData:0x9db0a98 @attributes={"instant_messengers"=>[], "twitter_accounts"=>[], "email_addresses"=>[], "phone_numbers"=>[], "addresses"=>[], "web_addresses"=>[]}, @prefix_options={}, @persisted=true>, "subject_datas"=>[#<Highrise::Person::SubjectData:0x9dafc88 @attributes={"id"=>118062439, "subject_field_id"=>878834, "subject_field_label"=>"Customer ID", "value"=>"A"}, @prefix_options={}, @persisted=true>]}, @prefix_options={}, @persisted=true>]
 
 
+########### conversion tests
+###################### contact
 class Contact
-	attr_accessor :name, :last_name, :email, :company, :job_title, :phone, :website
+  include HighriseWrapper::ActiveRecord
+  include Virtus.model
+
+  attribute :name, String
+  attribute :last_name, String
+  attribute :company_name, String
+  attribute :job_title, String
+  attribute :phone, String
+  attribute :website, String
+  attribute :email, String
+
+  def initialize attributes
+    attributes.each { |k, v| instance_variable_set("@#{k}", v) }
+  end
+end
+
+c = Contact.new({
+  :email => "ha@hihi.com",
+  :name => "Astolfo",
+  :last_name => "Aguiar",
+  :company_name => "AspasCorp",
+  :job_title => "Auxiliar",
+  :phone => "",
+  :website => ""})
+
+puts 'the contact'
+puts c.as_json
+puts
+
+###################### mapping v1
+class Person
+  attr_accessor :test_name, :test_last_name
+
+  def initialize site, user, attributes
+    @site = site
+    @user = user
+    attributes.each { |k, v| instance_variable_set("@test_#{k}", v) }
+  end
+end
+
+p = Person.new "site", "user", c.as_json
+puts 'the person'
+puts p.as_json
+puts
+
+###################### mapping v2
+class PersonMapper
+  include Virtus.model
+
+  attribute :first_name, String
+  attribute :last_name, String
+  attribute :title, String
+  attribute :company_name, String
+  attribute :avatar_url, String
+  attribute :email, String
+  attribute :home_phone, String
+end
+
+mapper = SimpleAttributeMapper::Mapper.new({
+  :name => :first_name,
+  :job_title => :title,
+  :phone => :home_phone
+})
 
-	def initialize site, user, attributes
-		@site = site
-		@user = user
-		attributes.each { |k, v| instance_variable_set("@#{k}", v) }
-	end
+p2 = mapper.map(c, PersonMapper)
+puts 'the person (mapped)'
+puts p2.as_json
+puts
 
-	def save
-	end
+###################### mapping v3
+
+hmapper = SimpleAttributeMapper::Mapper.new({
+  :name => :first_name,
+})
+
+hp = hmapper.map(c, Highrise::Person)
+puts 'the highrise person (mapped directly)'
+puts hp.as_json
+puts
+
+###################### mapping v4
+
+hp2 = Highrise::Person.new(p2.attributes)
+puts 'the highrise person (mapped with person mapper)'
+puts hp2.as_json
+puts
+
+###################### mapping v5
+
+class ContactDataMapper
+  include Virtus.model
+
+  attribute :email_addresses, Array
+  attribute :phone_numbers, Array
+  attribute :web_addresses, Array
+end
+
+class PersonMapper2
+  include Virtus.model
+
+  attribute :first_name, String
+  attribute :last_name, String
+  attribute :title, String
+  attribute :company_name, String
+  attribute :avatar_url, String
+  attribute :email, String
+  attribute :contact_data, ContactDataMapper
+end
+
+SimpleAttributeMapper.from(c).to(PersonMapper2).with({
+  :name => :first_name,
+  :job_title => :title,
+})
+
+
+###################### mapping v6
+
+def highrise_hash(contact)
+  {
+    'first_name' => contact.name,
+    'last_name' => contact.last_name,
+    'title' => contact.job_title,
+    'company_name' => contact.company_name,
+    'contact_data' =>  {
+      'email_addresses' => [{
+        'address' => contact.email,
+        'location' => 'Work'
+      }],
+      'phone_numbers' => [{
+        'number' => contact.phone,
+        'location' => 'Work'
+      }],
+      'web_addresses' => [{
+        'location' => 'Work',
+        'url' => contact.website
+      }]
+    }
+  }
 end
 
-#c = Contact.new "site", "user", {name: "fernando"}
-#puts c.name
-puts @people.to_json
+hp3 = Highrise::Person.new(highrise_hash(c))
+puts 'the highrise person (mapped with hash)'
+puts hp3.as_json
+puts
+
 
+#puts @people.to_json
 =begin
 {
-	"author_id":1018065,
-	"background":null,
-	"company_id":202863650,
-	"created_at":"2014-03-17T22:11:22Z",
-	"first_name":"Roberto",
-	"group_id":null,
-	"id":201374388,
-	"last_name":"Lobo",
-	"owner_id":null,
-	"title":"Project Manager",
-	"updated_at":"2014-03-29T20:40:56Z",
-	"visible_to":"Everyone",
-	"company_name":"Empresa",
-	"linkedin_url":null,
-	"avatar_url":"http://dge9rmgqjs8m1.cloudfront.net/highrise/missing/avatar.gif?r=3",
-	"contact_data": {
-		"instant_messengers":[],
-		"twitter_accounts":[],
-		"email_addresses":[{
-			"address":"rhlobo+highrise@gmail.com",
-			"id":103683105,
-			"location":"Home"
-		}],
-		"phone_numbers":[{
-			"id":164635766,
-			"location":"Work",
-			"number":"84442234"
-		}],
-		"addresses":[],
-		"web_addresses":[{
-			"id":164635767,
-			"location":"Work",
-			"url":"http://how.i.drycode.it"
-		}]
-	},
-	"subject_datas":[{
-		"id":118062439,
-		"subject_field_id":878834,
-		"subject_field_label":"Customer ID",
-		"value":"ID"
-	}]
+  "author_id":1018065,
+  "background":null,
+  "company_id":202863650,
+  "created_at":"2014-03-17T22:11:22Z",
+  "first_name":"Roberto",
+  "group_id":null,
+  "id":201374388,
+  "last_name":"Lobo",
+  "owner_id":null,
+  "title":"Project Manager",
+  "updated_at":"2014-03-29T20:40:56Z",
+  "visible_to":"Everyone",
+  "company_name":"Empresa",
+  "linkedin_url":null,
+  "avatar_url":"http://dge9rmgqjs8m1.cloudfront.net/highrise/missing/avatar.gif?r=3",
+  "contact_data": {
+    "instant_messengers":[],
+    "twitter_accounts":[],
+    "email_addresses":[{
+      "address":"rhlobo+highrise@gmail.com",
+      "id":103683105,
+      "location":"Home"
+    }],
+    "phone_numbers":[{
+      "id":164635766,
+      "location":"Work",
+      "number":"84442234"
+    }],
+    "addresses":[],
+    "web_addresses":[{
+      "id":164635767,
+      "location":"Work",
+      "url":"http://how.i.drycode.it"
+    }]
+  },
+  "subject_datas":[{
+    "id":118062439,
+    "subject_field_id":878834,
+    "subject_field_label":"Customer ID",
+    "value":"ID"
+  }]
 }
 =end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highrise_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.9
 platform: ruby
 authors:
 - rhlobo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
 description: ! "Gem to provide easy usage of Highrise API.\n                        Built
   wrapping the highrise gem, it is a POC\n                        created by me in
   order to study rubys platform"