highrise_mapper 0.0.2 → 0.0.3

data/.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
 pkg
 tmp
+
+#where I keep my 'export's for HIGHRISE_TOKEN and HIGHRISE_BASE_URL
+env.bash

data/.travis.yml

@@ -1,3 +1,5 @@
 rvm:
   - 2.0.0
-  - 1.9.3
+  - 1.9.3
+before_install:
+- gem install bundler

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    highrise_mapper (0.0.2)
+      highrise (~> 3.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activeresource (4.0.0)
+      activemodel (~> 4.0)
+      activesupport (~> 4.0)
+      rails-observers (~> 0.1.1)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.10)
+    builder (3.1.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    highrise (3.1.0)
+      activeresource (~> 4.0.0)
+    i18n (0.6.4)
+    method_source (0.8.1)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails-observers (0.1.1)
+      railties (~> 4.0.0.beta)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.5)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  highrise_mapper!
+  pry
+  pry-nav
+  rake
+  rspec
+  rspec-mocks

data/Rakefile

@@ -4,4 +4,12 @@ Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
-task :default => :build
+task :default => :travis
+
+task :travis do
+  ["rake spec", "rake build"].each do |cmd|
+    puts "Starting to run #{cmd}..."
+    system("export DISPLAY=:99.0 && bundle exec #{cmd}")
+    raise "#{cmd} failed!" unless $?.exitstatus == 0
+  end
+end

data/Readme.md

@@ -1,4 +1,4 @@
-[![Code Climate](https://codeclimate.com/github/lucasmartins/highrise-mapper.png)](https://codeclimate.com/github/lucasmartins/highrise-mapper) [![Build Status](https://secure.travis-ci.org/lucasmartins/highrise-mapper.png?branch=master)](https://travis-ci.org/lucasmartins/highrise-mapper) [![Dependency Status](https://gemnasium.com/lucasmartins/highrise-mapper.png)](https://gemnasium.com/lucasmartins/highrise-mapper)
+[![Gem version](https://badge.fury.io/rb/highrise_mapper.png)](http://rubygems.org/gems/highrise_mapper) [![Code Climate](https://codeclimate.com/github/lucasmartins/highrise-mapper.png)](https://codeclimate.com/github/lucasmartins/highrise-mapper) [![Build Status](https://secure.travis-ci.org/lucasmartins/highrise-mapper.png?branch=master)](https://travis-ci.org/lucasmartins/highrise-mapper) [![Dependency Status](https://gemnasium.com/lucasmartins/highrise-mapper.png)](https://gemnasium.com/lucasmartins/highrise-mapper)
 
 Highrise Mapper
 ===============
@@ -40,6 +40,12 @@ person:
   company_name: company_name
   email_address: email
 ```
+Non-Railers should call `HighriseMapper.config(root_directory)` on application bootstrap, where it will be mapped like this: 
+```ruby
+  "#{root_dir}/config/highrise_mapper.yml"
+```
+
+### Your model
 
 In this example, you could have a Person class like this one:
 
@@ -62,14 +68,81 @@ class Person
   end
 end
 ```
+### HighriseMapper::Person
+
+When including, the module `HighriseMapper::Person` will check for expected behavior from your class, so you will have to make some changes:
+
+```ruby
+class Person
+  def name
+    'Albert'
+  end
+
+  def last_name
+    'Einstein'
+  end
+
+  def company_name
+    self.company.name
+  end
+
+  def email
+    'albert.einstein@princeton.edu'
+  end
+
+  def highrise_context
+    #must return an instance that includes HighriseMapper::Context
+    self.highrise_account
+  end
+
+  def highrise_id
+    #must return the id this object has in Highrise
+    112233
+  end
+
+  #must be included after required behavior has been added to the Class
+  include HighriseMapper::Person
+end
+```
+
+Check the [specs](https://github.com/lucasmartins/highrise-mapper/tree/master/spec) to see the testing example, it will surely make it clearer.
+
 Notice that this implementation is database agnostic, there is no database reference whatsoever.
 
-Check the specs to see the testing example.
+Checkout the [sample rails application](https://github.com/lucasmartins/highrise-mapper-example).
+
+### HighriseMapper::Context
+
+When saving to Highrise, `HighriseMapper::Person` will look for the **base url** and **token** to connect to the right account, so you must have a model that represents this account configuration:
+
+```ruby
+class SaasCustomer
+  def name
+    'Rails na Praia'
+  end
+
+  def highrise_base_url
+    'https://railsnapraia.highrisehq.com'
+  end
+
+  def highrise_token
+    'a11386d68bdd94fe549b8498afafce56'
+  end
+  #must be included after required behavior has been added to the Class
+  include HighriseMapper::Context
+end
+```
+
+It is designed this way so your SaaS application (example) can connect to multiple Highrise accounts, then we can have an ERP/CRM SaaS application where each customer sets up their own Highrise account.
+
+Again, check the [specs](https://github.com/lucasmartins/highrise-mapper/tree/master/spec) and the [sample rails application](https://github.com/lucasmartins/highrise-mapper-example).
 
 Contribute
 ==========
 
-Just fork [HighriseMapper](https://github.com/lucasmartins/highrise-mapper), add your feature+spec, and make a pull request.
+Just fork [HighriseMapper](https://github.com/lucasmartins/highrise-mapper), add your feature+spec, and make a pull request. Do not mess up with the version file though.
+
+Also, if needed, update the code of the [sample application](https://github.com/lucasmartins/highrise-mapper-example).
 
 Support
 =======
@@ -79,4 +152,4 @@ This is an opensource project so don't expect premium support, but don't be shy,
 License
 =======
 
-Tacape Tools is free software under the [MIT license](http://lucasmartins.mit-license.org).
+Highrise Mapper is free software under the [MIT license](http://lucasmartins.mit-license.org).

data/highrise_mapper.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "highrise-rails4"
+  s.add_dependency "highrise", "~>3.1.0"
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-mocks"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry"
   s.add_development_dependency "pry-nav"

data/lib/highrise_mapper/context.rb

@@ -1,9 +1,6 @@
 module HighriseMapper
   module Context
 
-    module ClassMethods
-    end
-    
     module InstanceMethods
       def setup_highrise
         Highrise::Base.site = self.highrise_base_url
@@ -13,7 +10,6 @@ module HighriseMapper
     end
 
     def self.included(receiver)
-      receiver.extend         ClassMethods
       receiver.send :include, InstanceMethods
       check_expected_behavior(receiver)
     end

data/lib/highrise_mapper/person.rb

@@ -1,8 +1,5 @@
 module HighriseMapper
   module Person
-
-    module ClassMethods 
-    end
     
     module InstanceMethods
       def save_to_highrise
@@ -50,7 +47,6 @@ module HighriseMapper
     end
     
     def self.included(receiver)
-      receiver.extend         ClassMethods
       receiver.send :include, InstanceMethods
       check_expected_behavior(receiver)
     end

data/lib/highrise_mapper/version.rb

@@ -2,7 +2,7 @@ module HighriseMapper
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 2
+    PATCH = 3
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/highrise_mapper_spec.rb

@@ -1,6 +1,4 @@
 require "spec_helper"
-require 'pry'
-require 'pry-nav'
 
 describe HighriseMapper, "::config" do
   it "returns a valid configuration Hash" do

data/spec/person_spec.rb

@@ -1,26 +1,29 @@
 require "spec_helper"
 
-describe HighriseMapper::Person, "#save_to_highrise" do
-  it "persists the Highrise::Person successfully" do
-    HighriseMapper.config('templates')
-    contact = Contact.new
-    begin
-      result = contact.save_to_highrise
-      result.should be_a_kind_of(Fixnum)
-    ensure
-      Highrise::Person.find(result).destroy
+if highrise_env_available?
+  describe HighriseMapper::Person, "#save_to_highrise" do
+    it "persists the Highrise::Person successfully" do
+      HighriseMapper.config('templates')
+      contact = Contact.new
+      begin
+        result = contact.save_to_highrise
+        result.should be_a_kind_of(Fixnum)
+      ensure
+        Highrise::Person.find(result).destroy
+      end
     end
   end
-end
 
-describe HighriseMapper::Person, "#delete_from_highrise" do
-  it "deletes the Highrise::Person successfully" do
-    HighriseMapper.config('templates')
-    contact = Contact.new
-    highrise_person_id = contact.save_to_highrise
-    result = contact.delete_from_highrise(highrise_person_id)
-    result.should be_a_kind_of(Net::HTTPOK)
+  describe HighriseMapper::Person, "#delete_from_highrise" do
+    it "deletes the Highrise::Person successfully" do
+      HighriseMapper.config('templates')
+      contact = Contact.new
+      highrise_person_id = contact.save_to_highrise
+      result = contact.delete_from_highrise(highrise_person_id)
+      result.should be_a_kind_of(Net::HTTPOK)
+    end
   end
-end
-
-
+else
+  describe HighriseMapper::Person, "#save_to_highrise"
+  describe HighriseMapper::Person, "#delete_from_highrise"
+end

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
+require 'pry'
+require 'pry-nav'
 require "highrise_mapper"
+require 'rspec'
+require 'rspec/mocks'
 require "pathname"
 
 SPECDIR = Pathname.new(File.dirname(__FILE__))
@@ -7,7 +11,14 @@ TMPDIR = SPECDIR.join("tmp")
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|r| require r}
 
 RSpec.configure do |config|
-  config.include(SpecHelper)
-
   config.before { FileUtils.mkdir_p(TMPDIR) }
 end
+
+def highrise_env_available?
+  if ENV['HIGHRISE_TOKEN']!=nil && ENV['HIGHRISE_BASE_URL']!=nil && ENV['HIGHRISE_TOKEN']!='' && ENV['HIGHRISE_BASE_URL']!=''
+    return true
+  else
+    puts 'INFO: No Highrise TOKEN/BASEURL environment variable defined, tests regarding HTTP communication will be ignored.'
+    return false
+  end
+end

data/spec/support/contact.rb

@@ -1,4 +1,5 @@
 class Contact
+  extend RSpec::Mocks
   def name
     'Albert'
   end
@@ -16,7 +17,11 @@ class Contact
   end
 
   def highrise_context
-    SaasCustomer.new
+    @saas_customer = SaasCustomer.new
+    @saas_customer.stub(highrise_base_url: 'Rails on the beach' )
+    @saas_customer.stub(highrise_base_url: ENV['HIGHRISE_BASE_URL'] )
+    @saas_customer.stub(highrise_token: ENV['HIGHRISE_TOKEN'] )
+    return @saas_customer
   end
 
   def highrise_id

data/spec/support/saas_customer.rb

@@ -1,15 +1,14 @@
 class SaasCustomer
+  # check the mock in the contact.rb for more information on how this model should behave
   def name
-    'Rails na Praia'
   end
 
   def highrise_base_url
-    'https://railsnapraia.highrisehq.com'
   end
 
   def highrise_token
-    'a11386d68bdd94fe549b8498afafce56'
   end
+
   #must be included after required behavior has been added to the Class
   include HighriseMapper::Context
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highrise_mapper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: highrise-rails4
+  name: highrise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -102,6 +118,7 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - Rakefile
 - Readme.md
 - config/locales/en.yml
@@ -117,7 +134,6 @@ files:
 - spec/person_spec.rb
 - spec/spec_helper.rb
 - spec/support/contact.rb
-- spec/support/helper.rb
 - spec/support/saas_customer.rb
 - templates/config/highrise_mapper.yml
 homepage: http://rubygems.org/gems/highrise-mapper
@@ -150,6 +166,5 @@ test_files:
 - spec/person_spec.rb
 - spec/spec_helper.rb
 - spec/support/contact.rb
-- spec/support/helper.rb
 - spec/support/saas_customer.rb
 has_rdoc: 

data/spec/support/helper.rb

@@ -1,3 +0,0 @@
-module SpecHelper
-  
-end