contacts_client 0.0.1

data/app/models/address.rb

@@ -0,0 +1,15 @@
+class Address < ContactAttribute
+  attr_accessor :category, :postal_code, :city, :state, :country
+  self.attribute_keys = [:_id, :_type, :public, :primary, :category, :value, :postal_code, :city, :state, :country, :contact_id]
+
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  def _type
+    self.class.name
+  end
+end

data/app/models/attachment.rb

@@ -0,0 +1,40 @@
+class Attachment < LogicalModel
+  self.attribute_keys = [:_id, :file, :_type, :public, :name, :description, :contact_id, :account_name]
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/attachments"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  attr_accessor :name, :description, :file, :public, :primary
+
+  def new_record?
+    self._id.blank?
+  end
+
+  def always_public?
+    false
+  end
+
+  def json_root
+    :attachment
+  end
+
+  def to_key
+    [self._id]
+  end
+
+  def id
+    self._id
+  end
+
+  def id= id
+    self._id = id
+  end
+
+
+  def _type
+    self.class.name
+  end
+end

data/app/models/avatar.rb

@@ -0,0 +1,10 @@
+class Avatar < LogicalModel
+  self.hydra = Contacts::HYDRA
+
+  self.resource_path = "/v0/avatar"
+  self.attribute_keys = [:file]
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+end

data/app/models/contact_attribute.rb

@@ -0,0 +1,78 @@
+class ContactAttribute < LogicalModel
+
+  AVAILABLE_TYPES = %w(telephone email identification address date_attribute custom_attribute)
+
+  attr_accessor :public, :primary
+
+  self.attribute_keys = [:_id, :_type, :value, :public, :primary, :contact_id, :account_name]
+
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  def new_record?
+    self._id.blank?
+  end
+
+  def always_public?
+    false
+  end
+
+  validates :value, :presence => true, :unless => proc { self.is_a? DateAttribute }
+
+  def json_root
+    :contact_attribute
+  end
+
+  def to_key
+    [self._id]
+  end
+
+  def id
+    self._id
+  end
+
+  def id= id
+    self._id = id
+  end
+
+  #
+  # creates model.
+  # Override to set the primary boolean based on what is returned from the service
+  # TODO this could be done in an after_create
+  def _create(params = {})
+    return false unless valid?
+
+    params = { self.json_root => self.attributes }.merge(params)
+    params = self.class.merge_key(params)
+
+    response = nil
+
+    Timeout::timeout(self.class.timeout/1000) do
+      response = Typhoeus::Request.post( self.class.resource_uri, :params => params, :timeout => self.class.timeout )
+    end
+    if response.code == 201
+      log_ok(response)
+      self.id = ActiveSupport::JSON.decode(response.body)["id"]
+      #Set as primary according to json returned from service
+      self.primary = ActiveSupport::JSON.decode(response.body)["primary"]
+      return true
+    elsif response.code == 400
+      log_failed(response)
+      ws_errors = ActiveSupport::JSON.decode(response.body)["errors"]
+      ws_errors.each_key do |k|
+        self.errors.add k, ws_errors[k]
+      end
+      return false
+    else
+      log_failed(response)
+      return nil
+    end
+  rescue Timeout::Error
+    self.class.logger.warn "timeout"
+    return nil
+  end
+end

data/app/models/contacts_merge.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+class ContactsMerge < LogicalModel
+
+  self.hydra = Contacts::HYDRA
+
+  self.resource_path = "/v0/merges"
+  self.attribute_keys =
+      [
+          :id,
+          :first_contact_id,
+          :second_contact_id,
+          :state
+      ]
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  def json_root
+    'merge'
+  end
+
+  # Returns a Hash with the message corresponding
+  # to last create result
+  # @return [Hash]
+  # @example { alert: 'error' }
+  # @example { notice: 'success' }
+  def last_create_message_hash
+    case self.last_response_code
+      when 400
+        if self.errors.keys.include?(:similarity_of_contacts)
+          {alert: I18n.t('contacts_merge.not_similar')}
+        else
+          {alert: self.errors.messages}
+        end
+      when 401
+        {alert: I18n.t('contacts_merge.not_allowed', more: "[<a href='http://www.padma-support.com.ar/blog/n%C4%81o-tenho-permiss%C5%8Des-para-fundir-contatos' target='_blank'>?</a>]").html_safe}
+      when 201
+        {notice: I18n.t('contacts_merge.merged')}
+      when 202
+        case self.state
+          when 'pending_confirmation'
+            {notice: I18n.t('contacts_merge.pending_confirmation_of_admin')}
+          else
+            {notice: I18n.t('contacts_merge.started')}
+        end
+      else
+        {alert: I18n.t('contacts.communication_failure')}
+    end
+  end
+
+end

data/app/models/custom_attribute.rb

@@ -0,0 +1,16 @@
+class CustomAttribute < ContactAttribute
+  self.attribute_keys = [:_id, :_type, :public, :primary, :name, :value, :contact_id]
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  attr_accessor :name, :value, :public, :primary
+
+  def _type
+    self.class.name
+  end
+
+end

data/app/models/date_attribute.rb

@@ -0,0 +1,33 @@
+class DateAttribute < ContactAttribute
+  self.attribute_keys = [:_id, :_type, :public, :primary, :category, :contact_id, :year, :month, :day, :value]
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  attr_accessor :category, :public, :primary
+
+  validate :valid_date
+
+  before_save :set_value
+
+  def _type
+    self.class.name
+  end
+
+  private
+
+  def set_value
+    y = year.blank?? 0 : year.to_i
+    self.value = Date.civil(y,month.to_i,day.to_i) if Date.valid_civil?(y,month.to_i,day.to_i)
+  end
+
+  def valid_date
+    y = year.blank?? 2011 : year # 2011 is a leap year
+    unless Date.valid_civil?(y.to_i,month.to_i,day.to_i)
+      errors.add(nil)
+    end
+  end
+end

data/app/models/email.rb

@@ -0,0 +1,17 @@
+class Email < ContactAttribute
+  self.attribute_keys = [:_id, :_type, :public, :primary, :category, :value, :contact_id]
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  attr_accessor :category, :value, :public, :primary
+
+  def _type
+    self.class.name
+  end
+
+  validates :value, :email_format => true
+end

data/app/models/identification.rb

@@ -0,0 +1,20 @@
+class Identification < ContactAttribute
+  attr_accessor :category, :value, :public, :primary
+
+  self.attribute_keys = [:_id, :_type, :public, :primary, :category, :value, :contact_id]
+
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  def _type
+    self.class.name
+  end
+
+  def always_public?
+    true
+  end
+end

data/app/models/padma_contact.rb

@@ -0,0 +1,219 @@
+# encoding: UTF-8
+# wrapper for PADMA-Contacts API interaction
+# Configuration for LogicalModel on /config/initializers/logical_model.rb
+class PadmaContact < LogicalModel
+
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contacts"
+  self.attribute_keys =
+    [
+      :_id,
+      :first_name, :last_name,
+      :gender,
+      :avatar,
+      :status,
+      :local_status, # will only be setted if #find specifies account_name
+      :local_statuses,
+      :last_local_status,
+      :local_teacher,
+      :global_teacher_username,
+      :level,
+      :coefficient, # will only be setted if #find specifies account_name
+      :coefficients_counts,
+      :owner_name,
+      :linked, # will only be setted if #find specifies account_name
+      :check_duplicates,
+      :email, # Primary email (contact attribute)
+      :telephone, # Primary telephone (contact attribute)
+      :in_active_merge
+    ]
+  self.has_many_keys = [:contact_attributes, :attachments]
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  self.enable_delete_multiple = true
+
+  validates_presence_of :first_name
+  validates_inclusion_of :gender, in: %W(male female), allow_blank: true
+
+  validates_associated :contact_attributes
+  validates_associated :attachments
+
+  def json_root
+    :contact
+  end
+
+  TIMEOUT = 5500 # miliseconds
+  PER_PAGE = 9999
+
+  VALID_LEVELS = %W(aspirante sádhaka yôgin chêla graduado asistente docente maestro)
+  validates_inclusion_of :level, in: VALID_LEVELS, allow_blank: true
+
+  VALID_STATUSES = %W(student former_student prospect)
+  validates_inclusion_of :local_status, in: VALID_STATUSES, allow_blank: true
+  validates_inclusion_of :status, in: VALID_STATUSES, allow_blank: true
+
+  VALID_COEFFICIENTS = %W(unknown fp pmenos perfil pmas)
+  validates_inclusion_of :coefficient, in: VALID_COEFFICIENTS, allow_blank: true
+
+  def id
+    self._id
+  end
+
+  def id= id
+    self._id = id
+  end
+
+  # @return [Array<Communication>]
+  def communications
+    Communication.where(contact_id: self.id)
+  end
+
+  # @return [Array<Comment>]
+  def comments
+    Comment.where(contact_id: self.id)
+  end
+
+  # @return [Array<Communication>]
+  def subscription_changes
+    SubscriptionChange.where(contact_id: self.id)
+  end
+
+  # @argument [Hash] options
+  # @return [Array<ActivityStream::Activity>]
+  def activities(options={})
+    ActivityStream::Activity.paginate(options.merge({where: {target_id: self.id, target_type: 'Contact'}}))
+  end
+
+  def linked?
+    self.linked
+  end
+
+  def persisted?
+    self._id.present?
+  end
+
+  ContactAttribute::AVAILABLE_TYPES.each do |type|
+    define_method(type.to_s.pluralize) { self.contact_attributes.reject {|attr| !attr.is_a? type.to_s.camelize.constantize} }
+  end
+
+  def mobiles
+    self.contact_attributes.select{|attr| attr.is_a?(Telephone) && attr.category == "mobile"}
+  end
+
+  def non_mobile_phones
+    self.contact_attributes.select{|attr| attr.is_a?(Telephone) && attr.category != "mobile"}
+  end
+
+  def former_student_at
+    local_statuses.select{|s|s['value']=='former_student'}.map{|s|s['account_name']}
+  end
+
+  def prospect_at
+    local_statuses.select{|s|s['value']=='prospect'}.map{|s|s['account_name']}
+  end
+
+  def check_duplicates
+    @check_duplicates || false
+  end
+
+  # @return [Array<PadmaContac>] posible duplicates of this contact
+  def possible_duplicates
+    possible_duplicates = []
+    unless self.errors[:possible_duplicates].empty?
+      self.errors[:possible_duplicates][0][0].each do |pd|
+        possible_duplicates << PadmaContact.new(pd) #"#{pd["first_name"]} #{pd["last_name"]}"
+      end
+    end
+    possible_duplicates
+  end
+
+  # Returns total amount of coefficients this contact has assigned
+  # @return [ Integer ]
+  def coefficients_total
+    self.coefficients_counts.nil?? 0 : self.coefficients_counts.inject(0){|sum,key_value| sum += key_value[1]}
+  end
+
+  def in_active_merge?
+    self.in_active_merge
+  end
+
+  # Links contact to given account
+  #
+  # @param [String] contact_id
+  # @param [String] account_name
+  #
+  # returns:
+  # @return false if linking failed
+  # @return nil if there was a connection problem
+  # @return true if successfull
+  #
+  # @example
+  #   @contact.link_to(account)
+  def self.link(contact_id, account_name)
+    params = { account_name: account_name }
+    params = self.merge_key(params)
+
+    response = nil
+    Timeout::timeout(self.timeout/1000) do
+      response = Typhoeus::Request.post( self.resource_uri(contact_id)+"/link", :params => params, :timeout => self.timeout )
+    end
+    case response.code
+      when 200
+        log_ok response
+        return true
+      when 400
+        log_failed response
+        return false
+      else
+        log_failed response
+        return nil
+    end
+  rescue Timeout::Error
+    self.logger.warn "timeout"
+    return nil
+  end
+
+  ##
+  # Search is same as paginate but will make POST /search request instead of GET /index
+  #
+  # Parameters:
+  #   @param options [Hash].
+  #   Valid options are:
+  #   * :page - indicated what page to return. Defaults to 1.
+  #   * :per_page - indicates how many records to be returned per page. Defauls to 9999
+  #   * all other options will be sent in :params to WebService
+  #
+  # Usage:
+  #   Person.search(:page => params[:page])
+  def self.search(options = {})
+    options[:page] ||= 1
+    options[:per_page] ||= 9999
+
+    options = self.merge_key(options)
+
+    response = Typhoeus.post(self.resource_uri+'/search', body: options)
+
+
+    if response.success?
+      log_ok(response)
+      result_set = self.from_json(response.body)
+
+      # this paginate is will_paginate's Array pagination
+      return Kaminari.paginate_array(
+          result_set[:collection],
+          {
+              :total_count=>result_set[:total],
+              :limit => options[:per_page],
+              :offset => options[:per_page] * ([options[:page], 1].max - 1)
+          }
+      )
+    else
+      log_failed(response)
+      return nil
+    end
+  end
+
+end

data/app/models/telephone.rb

@@ -0,0 +1,21 @@
+class Telephone < ContactAttribute
+  self.attribute_keys = [:_id, :_type, :public, :primary, :category, :value, :contact_id]
+  self.hydra = Contacts::HYDRA
+  self.resource_path = "/v0/contact_attributes"
+  self.use_api_key = true
+  self.api_key_name = "app_key"
+  self.api_key = Contacts::API_KEY
+  self.host  = Contacts::HOST
+
+  attr_accessor :category, :value, :public, :primary
+
+  validates :value, :numericality => true, :unless => :masked?
+
+  def masked?
+    value.present? && value.last == '#'
+  end
+
+  def _type
+    self.class.name
+  end
+end

data/config/initializers/contacts_client.rb

@@ -0,0 +1,19 @@
+if(defined?(Rails))
+  module Contacts
+
+    unless defined? HYDRA
+      HYDRA = Typhoeus::Hydra.new
+    end
+
+    HOST = case Rails.env
+      when "production"
+        "padma-contacts.herokuapp.com"
+      when "staging"
+        "padma-contacts-staging.herokuapp.com"
+      when "development"
+         "localhost:3002"
+      when "test"
+         "localhost:3002"
+    end
+  end
+end

data/lib/contacts/belongs_to_contact.rb

@@ -0,0 +1,50 @@
+# this module assumes base class has a contact_id attribute.
+# expects base class to respond to :account_name
+module BelongsToContact
+
+  def self.included(base)
+    base.send(:validate, :padma_contact_setted_correctly)
+  end
+
+  attr_accessor :padma_contact
+  ##
+  # Returns associated contact.
+  #
+  # contact is stored in instance variable padma_contact. This allows for it to be setted in a Mass-Load.
+  #
+  # @param options [Hash]
+  # @option options [TrueClass] decorated          - returns decorated contact
+  # @option options [TrueClass] force_service_call - forces call to contacts-ws
+  # @return [PadmaContact / PadmaContactDecorator]
+  def contact(options={})
+    if self.padma_contact.nil? || options[:force_service_call]
+      self.padma_contact = PadmaContact.find(contact_id, {:account_name => self.account_name})
+    end
+    ret = padma_contact
+    if options[:decorated] && padma_contact
+      ret = PadmaContactDecorator.decorate(padma_contact)
+    end
+    ret
+  end
+
+  private
+
+  # If padma_contact is setted with a PadmaContact that doesn't match
+  # contact_id an exception will be raised
+  # @raises 'This is the wrong contact!'
+  # @raises 'This is not a contact!'
+  def padma_contact_setted_correctly
+    return if self.padma_contact.nil?
+    unless padma_contact.is_a?(PadmaContact)
+      raise 'This is not a contact!'
+    end
+    if padma_contact.id != self.contact_id
+      if self.contact_id.nil?
+        # if they differ because contact_id is nil we set it here
+        self.contact_id = self.padma_contact.id
+      else
+        raise 'This is the wrong contact!'
+      end
+    end
+  end
+end

data/lib/contacts/railties.rb

@@ -0,0 +1,4 @@
+module ContactsClient
+  class Engine < Rails::Engine
+  end
+end

data/lib/contacts/shared_examples.rb

@@ -0,0 +1,7 @@
+shared_examples_for "it belongs to a contact"  do
+  it { should validate_presence_of :contact_id }
+  it "should return account on #contact" do
+    PadmaContact.should_receive(:find).with(object.contact_id).and_return(PadmaContact.new(contact_id: object.contact_id))
+    object.contact.should be_a(PadmaContact)
+  end
+end

data/lib/contacts_client.rb

@@ -0,0 +1,5 @@
+require 'logical_model'
+if defined?(Rails)
+  require 'contacts/railties'
+  require 'contacts/belongs_to_contact'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: contacts_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dwayne Macgowan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: logical_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: This is client library for padma-Contacts-ws
+email:
+- dwaynemac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/date_attribute.rb
+- app/models/address.rb
+- app/models/identification.rb
+- app/models/email.rb
+- app/models/telephone.rb
+- app/models/custom_attribute.rb
+- app/models/padma_contact.rb
+- app/models/contacts_merge.rb
+- app/models/attachment.rb
+- app/models/contact_attribute.rb
+- app/models/avatar.rb
+- lib/contacts_client.rb
+- lib/contacts/shared_examples.rb
+- lib/contacts/railties.rb
+- lib/contacts/belongs_to_contact.rb
+- config/initializers/contacts_client.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Client library for padma-contacts-ws
+test_files: []
+has_rdoc: