highrise_mapper 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task :default => :build

data/Readme.md

@@ -0,0 +1,82 @@
+[![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
+===============
+
+This is a **WORK IN PROGRESS**
+
+This Gem depends heavily on the [Highrise](https://github.com/tapajos/highrise) Gem, and although you are encouraged to use it with Rails, I made it to be framework independent.
+
+This Gem adds [Highrise](https://github.com/tapajos/highrise) behavior to your models so you can call `@person.save_to_highrise`
+
+Install
+=======
+
+You can:
+```
+  $ gem install highrise-mapper
+```
+
+Or just add it to your Gemfile
+```
+  gem 'highrise-mapper'
+```
+
+Use
+===
+
+### Configuration file
+If you are on Rails, run the following command to generate a config file:
+
+`$ rails g highrise_mapper:config`
+
+This file maps between the fields Highrise expects and the fields/methods your model has, like this.
+
+```yml
+#highrise_key: Model key 
+person:
+  first_name: name
+  last_name: last_name
+  company_name: company_name
+  email_address: email
+```
+
+In this example, you could have a Person class like this one:
+
+```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
+end
+```
+Notice that this implementation is database agnostic, there is no database reference whatsoever.
+
+Check the specs to see the testing example.
+
+Contribute
+==========
+
+Just fork [HighriseMapper](https://github.com/lucasmartins/highrise-mapper), add your feature+spec, and make a pull request.
+
+Support
+=======
+
+This is an opensource project so don't expect premium support, but don't be shy, post any troubles you're having in the [Issues](https://github.com/lucasmartins/highrise-mapper/issues) page and we'll do what we can to help.
+
+License
+=======
+
+Tacape Tools is free software under the [MIT license](http://lucasmartins.mit-license.org).

data/config/locales/en.yml

@@ -0,0 +1 @@
+en:

data/config/locales/pt-BR.yml

@@ -0,0 +1 @@
+pt-BR:

data/highrise_mapper.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "highrise_mapper/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "highrise_mapper"
+  s.version               = HighriseMapper::Version::STRING
+  s.platform              = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 1.9.3"
+  s.authors               = ["Lucas Martins"]
+  s.email                 = ["lucasmartins@railsnapraia.com"]
+  s.homepage              = "http://rubygems.org/gems/highrise-mapper"
+  s.summary               = "Experimental Gem"
+  s.description           = s.summary
+  s.license               = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "highrise-rails4"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/generators/highrise_mapper/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a sample highrise_mapper.yml
+
+Example:
+    rails generate highrise_mapper:config
+
+    This will create:
+        config/highrise_mapper.yml

data/lib/generators/highrise_mapper/config_generator.rb

@@ -0,0 +1,10 @@
+module HighriseMapper
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../templates/config', __FILE__)
+
+    def create_config_file
+      config_yml = 'highrise_mapper.yml'
+      copy_file config_yml, "config/#{config_yml}"
+    end
+  end
+end

data/lib/highrise_mapper/context.rb

@@ -0,0 +1,32 @@
+module HighriseMapper
+  module Context
+
+    module ClassMethods
+    end
+    
+    module InstanceMethods
+      def setup_highrise
+        Highrise::Base.site = self.highrise_base_url
+        Highrise::Base.user = self.highrise_token
+        Highrise::Base.format = :xml  
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+      check_expected_behavior(receiver)
+    end
+
+    private
+    def self.check_expected_behavior(receiver)
+      unless receiver.method_defined? 'highrise_base_url'
+        raise 'Your model must respond to "highrise_base_url"'
+      end
+      unless receiver.method_defined? 'highrise_token'
+        raise 'Your model must respond to "highrise_token"'
+      end
+    end
+  end
+
+end

data/lib/highrise_mapper/person.rb

@@ -0,0 +1,69 @@
+module HighriseMapper
+  module Person
+
+    module ClassMethods 
+    end
+    
+    module InstanceMethods
+      def save_to_highrise
+        unless HighriseMapper.config['person'].is_a? Hash
+          raise 'Your highrise_mapper.yml does not contain the "person" configuration key.'  
+        end
+        self.highrise_context.setup_highrise
+        highrise_person = Highrise::Person.new(build_highrise_hash)
+
+        begin
+          highrise_person.save!
+        rescue Exception => e
+          #shoud get rails logger if available
+          puts highrise_person.errors
+        end
+        return highrise_person.attributes['id']
+      end
+
+      def delete_from_highrise(force_id=nil)
+        if force_id!=nil
+          highrise_id = force_id
+        else
+          highrise_id = self.highrise_id
+        end
+        self.highrise_context.setup_highrise
+        highrise_person = Highrise::Person.find(highrise_id)
+        highrise_person.destroy
+      end
+
+      def build_highrise_hash
+        new_hash = {}
+        config = HighriseMapper.config
+        config['person'].each do |k,v|
+          if v!=nil && v!=''
+            case k
+            when 'email_address'
+              new_hash['contact_data']={'email_addresses'=>[{'address'=> self.send(v),'location'=>''}]}
+            else
+              new_hash[k]=self.send(v)
+            end
+          end
+        end
+        return new_hash
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+      check_expected_behavior(receiver)
+    end
+
+    private
+    def self.check_expected_behavior(receiver)
+      unless receiver.method_defined? 'highrise_context'
+        raise 'Your model must respond to "highrise_context", where it returns the Instace of the HighriseMapper::Context model'
+      end
+      unless receiver.method_defined? 'highrise_id'
+        raise 'Your model must respond to "highrise_id", where it returns the id of its remote representation on Highrise (or nil if not existant)'
+      end
+    end
+  end
+
+end

data/lib/highrise_mapper/version.rb

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

data/lib/highrise_mapper.rb

@@ -0,0 +1,38 @@
+require 'highrise'
+require 'erb'
+require 'logger'
+require 'tempfile'
+require 'pathname'
+require 'yaml'
+
+Encoding.default_internal = "utf-8"
+Encoding.default_external = "utf-8"
+
+#Adds a way to retrieve Submodules of a Module, used for CustomContentParsers
+class Module
+  def submodules
+    constants.collect {|const_name| const_get(const_name)}.select {|const| const.class == Module}
+  end
+end
+
+module HighriseMapper
+
+  load 'highrise_mapper/context.rb'
+  load 'highrise_mapper/person.rb'
+
+  def self.config(root_dir=nil)
+    @config ||= load_config(root_dir)
+  end
+
+  def self.load_config(root_dir=nil)
+    root_dir ||= Pathname.new(Dir.pwd)
+    
+    path = "#{root_dir}/config/highrise_mapper.yml"
+
+    raise "Couldn't find config yml at #{path}." unless File.file?(path)
+    content = File.read(path)
+    erb = ERB.new(content).result
+    YAML.load(erb).with_indifferent_access
+  end
+
+end

data/spec/highrise_mapper_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+require 'pry'
+require 'pry-nav'
+
+describe HighriseMapper, "::config" do
+  it "returns a valid configuration Hash" do
+    config = HighriseMapper.config('templates')
+    config.should be_a_kind_of(Hash)
+    config.should have_key('person')
+  end
+end

data/spec/person_spec.rb

@@ -0,0 +1,26 @@
+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
+    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)
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "highrise_mapper"
+require "pathname"
+
+SPECDIR = Pathname.new(File.dirname(__FILE__))
+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

data/spec/support/contact.rb

@@ -0,0 +1,27 @@
+class Contact
+  def name
+    'Albert'
+  end
+
+  def last_name
+    'Einstein'
+  end
+
+  def company_name
+    'Princeton University'
+  end
+
+  def email
+    'albert.einstein@princeton.edu'
+  end
+
+  def highrise_context
+    SaasCustomer.new
+  end
+
+  def highrise_id
+    112233
+  end
+  #must be included after required behavior has been added to the Class
+  include HighriseMapper::Person
+end

data/spec/support/helper.rb

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

data/spec/support/saas_customer.rb

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

data/templates/config/highrise_mapper.yml

@@ -0,0 +1,10 @@
+# For a documentation on Highrise keys, refer to:
+#  https://github.com/37signals/highrise-api/blob/master/sections/data_reference.md#person
+# NOTE: You should replace '-' with '_', like: first-name -> first_name
+#
+# On the left goes the Highrise key, on the right goes you model's field/method 
+person:
+  first_name: name
+  last_name: last_name
+  company_name: company_name
+  email_address: email

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: highrise_mapper
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Martins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highrise-rails4
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Experimental Gem
+email:
+- lucasmartins@railsnapraia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Rakefile
+- Readme.md
+- config/locales/en.yml
+- config/locales/pt-BR.yml
+- highrise_mapper.gemspec
+- lib/generators/highrise_mapper/USAGE
+- lib/generators/highrise_mapper/config_generator.rb
+- lib/highrise_mapper.rb
+- lib/highrise_mapper/context.rb
+- lib/highrise_mapper/person.rb
+- lib/highrise_mapper/version.rb
+- spec/highrise_mapper_spec.rb
+- 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
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Experimental Gem
+test_files:
+- spec/highrise_mapper_spec.rb
+- spec/person_spec.rb
+- spec/spec_helper.rb
+- spec/support/contact.rb
+- spec/support/helper.rb
+- spec/support/saas_customer.rb
+has_rdoc: