sukremore 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3cea609e9f45e9730ed3c33846b0933e882113dd
+  data.tar.gz: 4e65b678654e33b8637e4beb0fa7ac3f97cef544
+SHA512:
+  metadata.gz: 2b1194857bc56ef33ca996976571507a2c8d8d49df9c66c69b1fcc85c33e5e313b5b55a7a6f09d4b254914e22e12f0b3fe4d2b01c5ecf5371943bb840eb85098
+  data.tar.gz: c2c965b26cb127d727a425eddd84cd3516f59c5bc297521116fc3af7c75b36ccc81f1860edfe24c3895b02447fcb9bb60f0a4f869df451c2469b00f950a4bfd5

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/nbproject/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sukremore.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Oliver HV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+sukremore
+=========
+
+# Sukremore
+
+Client for the Rest SugarCRM webservice.
+In this very first version only limited access to Account and Contact models is implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sukremore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sukremore
+
+## Usage
+
+TODO: Write usage instructions here
+
+Documentation for the WS's API can be found at the CRM itself: http://crm.coditramuntana.com/service/v2/rest.php
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sukremore.rb

@@ -0,0 +1,12 @@
+require "sukremore/version"
+require "sukremore/client"
+
+module Sukremore
+  def logger
+    if defined? Rails
+      Rails.logger
+    else
+      Logger.new(STDOUT)
+    end
+  end
+end

data/lib/sukremore/client.rb

@@ -0,0 +1,182 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'sukremore/modules/base'
+require 'sukremore/modules/account'
+require 'sukremore/modules/email'
+require 'sukremore/modules/lead'
+
+# 
+# To use the Sukremore::Client the first thing to do is call user_auth so that
+# the client authenticates with SugarCRM. Once authenticated, the rest of the calls
+# may be performed without authenticating again.
+# 
+# For more documentation on the SugarCRM Rest API check:
+# http://xxx-crm.coditramuntana.com/service/v2/rest.php
+#
+module Sukremore
+  class Client
+    include Sukremore
+    attr_reader :endpoint_name
+
+    def initialize url, config
+      @url= url
+      @config= config
+      @endpoint_name= @config['endpoint_name'] || 'Web'
+    end
+
+    # Authenticates with the given SugarCRM
+    # Returns true if succeeded, false otherwise.
+    def user_auth
+      sugar_resp = sugar_do_rest_call(
+        @url, 
+        'login', 
+        :user_auth => {:user_name => @config['username'], :password => Digest::MD5.hexdigest(@config['password']), :version => @config['api_version']}
+      )
+      @session_id = sugar_resp['id']
+      @logged_user= find_user_by_name @config['username']
+      raise "Error performing login to SugarCRM, returned session_id is nil" if @session_id.blank?
+    end
+
+    def from_leads
+      Modules::Lead.new(self)
+    end
+
+    def from_accounts
+      Modules::Account.new(self)
+    end
+
+    def from_emails
+      Modules::Email.new(self)
+    end
+
+    # GET
+    # Get the first user named with the name arg.
+    # Returns nil if not found.
+    #
+    def find_user_by_name name
+      users= find_users_by_name name
+      users.first
+    end
+
+    # GET
+    # Get the users named with the name arg.
+    #
+    def find_users_by_name name
+      sugar_resp = sugar_do_rest_call(
+        @url, 
+        'get_entry_list',
+        { :session => @session_id, 
+          :module_name => "Users", 
+          :query => "user_name='#{name}'",#"email_address IN ('#{email}')", # the SQL WHERE clause without the word “where”.
+          :order_by => '', # the SQL ORDER BY clause without the phrase “order by”.
+          :offset => '0', # the record offset from which to start.
+          :select_fields => ['email_address'],
+          :max_results => '1',
+          #:link_name_to_fields_array => [{:name => 'id'}, {:value => ['id', 'name']}],
+          :deleted => 0, # exclude deleted records
+          :favorites => false # if only records marked as favorites should be returned.
+        }
+      )
+      return sugar_resp["entry_list"]
+    end
+
+    # SET ENTRY
+    # Creates or updates an entity
+    def set_entry module_name, entry
+      names_values = []
+      names_values << {:name => "id", :value => entry[:id]} if entry[:id].present?
+      names_values << {:name => "date_entered", :value => Time.now} if entry[:id].blank?
+      names_values << {:name => "created_by", :value => @logged_user['id']}  if entry[:id].blank?
+      names_values << {:name => "date_modified", :value => Time.now}
+      names_values << {:name => "modified_user_id", :value => @logged_user['id']}
+      entry.entries.each do |field, value|
+        names_values << {:name => field, :value => value}
+      end
+
+      sugar_resp= sugar_do_rest_call(
+        @url,
+        'set_entry',
+        {
+          :session => @session_id,
+          :module_name => module_name,
+          :name_value_list => names_values
+        }
+      )
+      sugar_resp['id']
+    end
+
+    def get_entry_list module_name, params={}
+      sugar_rs= sugar_do_rest_call(
+        @url,
+        'get_entry_list',
+        { :session => @session_id,
+          :module_name => module_name, 
+        }.merge(params)
+      )
+      sugar_rs
+    end
+    # SET
+    # Insert relation between modules
+    def set_relationship src_module_name, src_module_id, link_field_name, related_ids
+      sugar_resp = sugar_do_rest_call(
+        @url,
+        'set_relationship',
+        {
+          :session => @session_id,
+          :module_name => src_module_name,
+          :module_id => src_module_id,
+          :link_field_name => link_field_name,
+          :related_ids => related_ids,
+        }
+      )
+      sugar_resp["id"]
+    end
+
+    #
+    # Converts a Sugar Entity into a simple Ruby hash.
+    #
+    def import_sugar_entity sugar_entity
+      entity= {}
+      sugar_entity['name_value_list'].values.each do |field|
+        entity[field['name']]= field['value']
+      end
+      entity
+    end
+    #--------------------------------------------------------------------------
+    private
+    #--------------------------------------------------------------------------
+
+    #
+    # Do a POST to SugarCRM
+    # 
+    # NOTE: Order of +params+ IS important.
+    # 
+    #
+    def sugar_do_rest_call(url, method, params = {})
+      uri = URI(url)
+      http = Net::HTTP.new uri.host, uri.port
+      http.open_timeout = 30
+      # Uncoment this two lines for use SSL
+      # http.use_ssl = true
+      # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      json_params= params.to_json
+      logger.debug "rest_call request method: #{method} params:#{json_params}"
+      post_data = {
+        :method => method,
+        :input_type => 'JSON',
+        :response_type => 'JSON',
+        :rest_data => json_params,
+      }
+      http_resp = Net::HTTP.post_form(uri, post_data)
+      logger.debug "rest_call response:::#{http_resp}=#{http_resp.body}"
+      json_rs= JSON.parse(http_resp.body)
+      if json_rs['number'] == 11
+        # 11=> Invalid Session ID
+        raise http_respt.body
+      end
+      json_rs
+    end
+  end
+end

data/lib/sukremore/modules/account.rb

@@ -0,0 +1,117 @@
+#
+# Account Module fields
+# ---------------
+# assigned_user_name
+# modified_by_name
+# created_by_name
+# id
+# name
+# date_entered
+# date_modified
+# modified_user_id
+# created_by
+# description
+# deleted
+# assigned_user_id
+# account_type
+# industry
+# annual_revenue
+# phone_fax
+# billing_address_street
+# billing_address_city
+# billing_address_state
+# billing_address_postalcode
+# billing_address_country
+# rating
+# phone_office
+# phone_alternate
+# website
+# ownership
+# employees
+# ticker_symbol
+# shipping_address_street
+# shipping_address_city
+# shipping_address_state
+# shipping_address_postalcode
+# shipping_address_country
+# email1
+# parent_id
+# sic_code
+# parent_name
+# campaign_id
+# campaign_name
+# cifra_negocio_c
+# interes_en_prod_c
+# currency_id
+#
+module Sukremore
+  module Modules
+    class Account < Base
+      MODULE_NAME= 'Accounts'
+      #
+      # Do a rest call to a SugarCRM Account by the given query
+      #
+      def sugar_get_account_by_query sql_cond= nil
+        raise "session_id[#{@session_id}]/url[#{@url}] can't be nil" if @session_id == nil || @url == nil
+
+        sugar_resp = @client.get_entry_list(MODULE_NAME, {
+          :query => sql_cond, # the SQL WHERE clause without the word “where”.
+          :order_by => '', # the SQL ORDER BY clause without the phrase “order by”.
+          :offset => '0', # the record offset from which to start.
+          :select_fields => ['id', 'nif_code_c', 'name', 'billing_address_street', 'phone_office_label', 'billing_address_city', 'billing_address_state', 'billing_address_postalcode', 'billing_address_country', 'website', 'email_adresse_c'],
+          :max_results => '10',
+          #:link_name_to_fields_array => [{:name => 'id'}, {:value => ['id', 'name']}],
+          :deleted => 0, # exclude deleted records
+          :favorites => false # if only records marked as favorites should be returned.
+        })
+
+        return sugar_resp
+      end
+
+      def create fields
+        @client.set_entry MODULE_NAME, fields
+      end
+
+      #
+      # Opts:
+      # - +select_fields+ defaults to all.
+      #
+      def find_all_accounts opts={}
+        pending_pages= true
+        accounts= []
+        offset= 0
+        sugar_resp= nil
+        while pending_pages
+          offset= sugar_resp['next_offset'] unless sugar_resp.nil?
+          opts[:offset]= offset
+          sugar_resp= query_accounts(opts)
+          pending_pages= (sugar_resp['result_count'] > 0) && (sugar_resp['result_count'] != sugar_resp['next_offset'])
+          sugar_resp['entry_list'].each do |sa|
+            accounts << @client.import_sugar_entity(sa)
+          end
+        end
+        accounts
+      end
+
+      def query_accounts opts={}
+        # Order of parameters IS important
+        params= {}
+        params[:query]= opts[:query] unless opts[:query].nil?
+        ## the record offset from which to start.
+        params[:offset]= opts[:offset].nil? ? 0 : opts[:offset]
+        # exclude deleted records
+        params[:deleted]= opts[:deleted].nil? ? 0 : opts[:deleted]
+        params[:select_fields]= opts[:select_fields] unless opts[:select_fields].nil?
+        params[:offset]= opts[:offset] unless opts[:offset].nil?
+        sugar_resp = @client.get_entry_list(MODULE_NAME, params)
+
+        return sugar_resp
+      end
+
+      #-----------------------------------------------------------
+      private
+      #-----------------------------------------------------------
+
+    end
+  end
+end

data/lib/sukremore/modules/base.rb

@@ -0,0 +1,11 @@
+# Main abstract class for all module specific classes.
+module Sukremore
+  module Modules
+    class Base
+      include Sukremore
+      def initialize client
+        @client= client
+      end
+    end
+  end
+end

data/lib/sukremore/modules/email.rb

@@ -0,0 +1,47 @@
+module Sukremore
+  module Modules
+    class Email < Base
+      MODULE_NAME= 'EmailAddresses'
+      # GET  --------------------
+      # Returns the ID for the given email if it exists, false otherwise.
+      def email_id? email
+        raise "email can't be nil" if email == nil
+        sugar_resp = @client.get_entry_list(MODULE_NAME, {
+            :query => 'email_address=\''+ email +'\'',#"email_address IN ('#{email}')", # the SQL WHERE clause without the word “where”.
+            :order_by => '', # the SQL ORDER BY clause without the phrase “order by”.
+            :offset => '0', # the record offset from which to start.
+            :select_fields => ['email_address'],
+            :max_results => '1',
+            #:link_name_to_fields_array => [{:name => 'id'}, {:value => ['id', 'name']}],
+            :deleted => 0, # exclude deleted records
+            :favorites => false # if only records marked as favorites should be returned.
+          }
+        )
+        if sugar_resp['entry_list'].any?
+          sugar_resp['entry_list'][0]['id']
+        else
+          false
+        end
+      end
+
+      # SET
+      # insert email.
+      # Returns the email id on success, otherwise returns nil.
+      def insert_email email
+        raise "really? add new a new empty account?" if email.nil? or email.empty?
+
+        email_params = {
+          email_address: email,
+          email_address_caps: email.upcase,
+          invalid_email: false,
+          opt_out: false,
+          created_at: Time.now,
+          updated: Time.now
+        }
+
+        @client.set_entry Email::MODULE_NAME, email_params
+      end
+
+    end
+  end
+end

data/lib/sukremore/modules/lead.rb

@@ -0,0 +1,56 @@
+module Sukremore
+  module Modules
+    class Lead < Base
+      MODULE_NAME= 'Leads'
+
+      # Inserts a new lead into the SugarCRM.
+      # 
+      #
+      # Accepted params (symbol keys) are:
+      # - :lead_id <- may be null on create.
+      # - :lead_desc
+      # - :name
+      # - :email1
+      # 
+      # Returns the id of the lead on success, otherwise returns nil.
+      def set_lead lead={}
+        raise "really? add new a new empty lead?" if lead.empty?
+
+        if lead[:description].nil? or lead[:description].empty?
+          lead[:description]= "Lead generated from #{@client.endpoint_name}-> [(#{Time.now})- #{lead[:text]}]"
+        end
+        if lead[:lead_source].nil? || lead[:lead_source].empty?
+          lead[:lead_source]= @client.endpoint_name
+        end
+        if lead[:status].nil? || lead[:status].empty?
+          lead[:lead_source]= 'New'
+        end
+
+        @client.set_entry Lead::MODULE_NAME, lead
+      end
+
+      # GET lead id and desc searching by email
+      def get_lead_by_email email_id
+        query = %Q{leads.id in
+        (select email_addr_bean_rel.bean_id 
+          from email_addr_bean_rel 
+          where email_addr_bean_rel.bean_module = 'Leads'
+          and email_addr_bean_rel.email_address_id = '#{email_id}'
+          )
+        }
+        sugar_resp = @client.get_entry_list(MODULE_NAME, {
+          :query => query,
+          :order_by => '', # the SQL ORDER BY clause without the phrase “order by”.
+          :offset => '0', # the record offset from which to start.
+          :select_fields => ['id', 'description'],
+          :max_results => '1',
+          :deleted => 0, # exclude deleted records
+          :favorites => false # if only records marked as favorites should be returned.
+        })
+        return {:lead_id => nil, :lead_desc => ""} if sugar_resp["entry_list"].length == 0
+        {:lead_id => sugar_resp["entry_list"][0]["id"], :lead_desc => sugar_resp["entry_list"][0]["name_value_list"]["description"]["value"]}
+      end
+
+    end
+  end
+end

data/lib/sukremore/version.rb

@@ -0,0 +1,3 @@
+module Sukremore
+  VERSION = "0.0.1"
+end

data/sukremore.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sukremore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sukremore"
+  spec.version       = Sukremore::VERSION
+  spec.authors       = ["Oliver HV"]
+  spec.email         = ["oliver.hv@coditramuntana.com"]
+  spec.description   = %q{Client for the Rest SugarCRM webservice.}
+  spec.summary       = %q{In this very first version only limited access to Account, Email and Lead models is implemented.}
+  spec.homepage      = "http://www.coditramuntana.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sukremore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oliver HV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  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'
+description: Client for the Rest SugarCRM webservice.
+email:
+- oliver.hv@coditramuntana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sukremore.rb
+- lib/sukremore/client.rb
+- lib/sukremore/modules/account.rb
+- lib/sukremore/modules/base.rb
+- lib/sukremore/modules/email.rb
+- lib/sukremore/modules/lead.rb
+- lib/sukremore/version.rb
+- sukremore.gemspec
+homepage: http://www.coditramuntana.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: In this very first version only limited access to Account, Email and Lead
+  models is implemented.
+test_files: []