mycrm 0.0.41

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2d05640d72f98ddd72af6846858fbbd30e8acd6
+  data.tar.gz: fe35fee156ef2586a2badf552716e5ebff67c916
+SHA512:
+  metadata.gz: e2dbbe09306e7f9455ed9b4516bab95407c6a2df10adb09a3938c426a3cb62edef108d2a828b14f6d8df2ede2aa2cd35699ce3bd392b1cf6dcf3099ff4844c1c
+  data.tar.gz: dd87fc2be3e1d11f458abf02c6026d76b2f621ee4a95bc0239067e2bd9be1bba6cc74aa48d38ac14392e6f17a8cb46629fb37870e58eb5f2ac6f4e261fed48ff

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Danilo Lo Santo
+
+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,112 @@
+# Mycrm Gem
+
+A library to simplify communication with the MyCrm data service.
+
+## Configuration
+
+```
+storage = Redis.new({"host"=>"localhost", "port"=>6379, "namespace"=>"loan-market-platform-development"})
+Mycrm.configure do |conf|
+  conf.base_uri = 'https://api.endopoint.com'
+  conf.username = 'some-user-name'
+  conf.password = 'very-secret'
+  conf.logger = ::Logger.new(STDOUT)
+  conf.storage = storage
+  conf.token_storage_expiry = 600 # in seconds default 10 minutes (600)
+  # it overrides the default domains' values
+  conf.domains = {
+    sources: {
+      lm_contact_us: -9
+    },
+    purposes: {
+      first_home: 17207
+    },
+    loan_features:{
+      other: 16928
+    },
+    adviser_sources:{
+      loan_market_careers_website: 16
+    },
+    adviser_types:{
+      mortgage_broker: 7829
+    },
+    other_option:{
+      other: 36928
+    }
+  }
+end
+```
+
+## Create a new simple lead
+
+```
+lead = Mycrm::Facades::Lead.new
+lead.first_name = 'Michael'
+lead.last_name = 'Stephens'
+lead.email = 'michael.stephens@example.com'
+lead.mobile = '0555123457'
+lead.home_address = '135 King Street, 2000, Sydney, NSW, Australia'
+lead.mobile_validated = true
+lead.allocated_broker_id = 858860
+lead.source = 'Lm Contact Us'
+lead.activity_title = 'Gem Enquiry!'
+lead.activity_details = 'I would like to ask...'
+
+lead.create!
+```
+
+## Create a new lead with loan application
+
+```
+lead = Mycrm::Facades::LeadApplication.new
+lead.first_name = 'Michael'
+lead.last_name = 'Stephens'
+lead.email = 'michael.stephens@example.com'
+lead.mobile = '0555123457'
+lead.home_address = '135 King Street, Sydney, 2000, NSW'
+lead.mobile_validated = true
+lead.allocated_broker_id = 858860
+lead.source = 'Lm Contact Us'
+lead.settlement_date = "2017-06-06T23:38:18.609Z"
+lead.add_purpose 'First Home'
+lead.add_feature 'Other'
+lead.loan_term = 120
+lead.loan_amount = 35000
+lead.activity_title = 'Gem Enquiry!'
+lead.activity_details = 'I would like to ask...'
+
+lead.create!
+```
+
+## Create a new prospect adviser
+```
+adviser = Mycrm::Models::Adviser.new
+adviser.first_name = 'James'
+adviser.last_name = 'Smith'
+adviser.email = 'james.smith@example.com'
+adviser.mobile = '0555123457'
+adviser.business_phone = '0405666555'
+adviser.business_address = '135 King Street, Sydney, 2000, NSW'
+adviser.summary = "I'm looking for job!"
+adviser.source = 'Loan Market Careers Website'
+adviser.reporting_country = 'Australia'
+adviser.type = 'Mortgage Broker'
+
+adviser.create!
+```
+
+## Development
+
+### Running tests in development
+
+Some of the tests run against the test instance of the actual My CRM API.
+
+To run these locally add a `.env.local` file with `API_BASE_URI`, `API_USERNAME`, and `API_PASSWORD`:
+
+```
+API_BASE_URI=https://testapi.nzfsg.co.nz
+API_USERNAME=$api-user-email
+API_PASSWORD=$api-user-password
+```
+
+Get the propper details off one of the Loan Market developers.

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# require 'rdoc/task'
+
+# RDoc::Task.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title    = 'Mycrm'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+Bundler::GemHelper.install_tasks

data/lib/mycrm.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+require 'mycrm/core_ext'
+
+require 'mycrm/attributes'
+require 'mycrm/connectable'
+require 'mycrm/domains'
+require 'mycrm/facades'
+require 'mycrm/models'
+require 'mycrm/version'
+
+module Mycrm
+  class << self
+    attr_reader :configuration
+
+    private
+
+    attr_writer :configuration
+
+    def set_domains
+      configuration.domains = YAML.load_file(domains_file)
+        .depp_merge(configuration.domains.to_h.stringify_keys_deep!)
+        .stringify_keys_deep!
+    end
+
+    def domains_file
+      File.join(File.dirname(__FILE__), 'mycrm/resources', 'domains.yml')
+    end
+  end
+
+  def self.configure
+    self.configuration = Configuration.new
+    yield(configuration)
+    set_domains
+  end
+
+  def self.log(level, message)
+    return unless configuration.logger
+    configuration.logger.send level, message
+  end
+
+  class Configuration
+    attr_accessor :base_uri, :username, :password, :logger, :domains, :storage, :token_storage_expiry
+  end
+
+  class ApiError < StandardError; end
+  class ResponseError < StandardError; end
+  class ConnectionError < StandardError; end
+end

data/lib/mycrm/attributes.rb

@@ -0,0 +1,5 @@
+require_relative 'attributes/name'
+require_relative 'attributes/date'
+require_relative 'attributes/address'
+require_relative 'attributes/deposit'
+require_relative 'attributes/organization'

data/lib/mycrm/attributes/address.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Mycrm
+  module Attributes
+    class Address
+      include Virtus.model
+
+      attribute :home, String
+      attribute :mail, String
+      attribute :business, String
+    end
+  end
+end

data/lib/mycrm/attributes/date.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Mycrm
+  module Attributes
+    class Date
+      include Virtus.model
+
+      attribute :day, String
+      attribute :month, String
+      attribute :year, String
+    end
+  end
+end

data/lib/mycrm/attributes/deposit.rb

@@ -0,0 +1,12 @@
+require 'virtus'
+
+module Mycrm
+  module Attributes
+    class Deposit
+      include Virtus.model
+
+      attribute :amount, Integer
+      attribute :source_id, Integer
+    end
+  end
+end

data/lib/mycrm/attributes/name.rb

@@ -0,0 +1,18 @@
+require 'virtus'
+
+module Mycrm
+  module Attributes
+    class Name
+      include Virtus.model
+
+      attribute :display, String #, default: :default_display_name
+      attribute :first, String
+      attribute :last, String
+      attribute :middle, String
+
+      def set_default_display_name
+        self.display = [first, last].join(' ') if first || last
+      end
+    end
+  end
+end

data/lib/mycrm/attributes/organization.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Mycrm
+  module Attributes
+    class Organization
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :name, String
+      attribute :website, String
+    end
+  end
+end

data/lib/mycrm/connectable.rb

@@ -0,0 +1,107 @@
+require 'faraday'
+require 'json'
+
+module Mycrm
+  # this module adds connectivity methods to the descendant's class
+  module Connectable
+    TOKEN_KEY = 'mycrm_auth_token_key'
+    DEFAULT_TOKEN_EXPIRE_IN_STORAGE = 600 # 10 minutes
+
+    def self.extended(descendant)
+      descendant.send(:extend, ExtendedMethods)
+    end
+
+    class << self
+      #create the connection with basic configurations
+      def connection
+        Faraday.new(url: Mycrm.configuration.base_uri) do |faraday|
+          faraday.request :url_encoded
+          if Mycrm.configuration.logger
+            faraday.response :logger, Mycrm.configuration.logger, bodies: true
+          end
+          yield(faraday) if block_given?
+          faraday.adapter Faraday.default_adapter
+        end
+      rescue Errno::ECONNREFUSED => e
+        raise ConnectionError, e
+      end
+
+      def token
+        @token || fetch_token
+      end
+
+      def fetch_token
+        storage = Mycrm.configuration.storage # Redis or any strategy that implement set and get
+
+        if storage
+          token = storage.get(TOKEN_KEY)
+          if token && !(token.nil? || token.empty?)
+            token
+          else
+            token_storage_expiry = Mycrm.configuration.token_storage_expiry || DEFAULT_TOKEN_EXPIRE_IN_STORAGE
+            token = fetch_token_from_mycrm
+            storage.set(TOKEN_KEY, token, ex: token_storage_expiry)
+            token
+          end
+        else
+          fetch_token_from_mycrm
+        end
+      end
+
+      def fetch_token_from_mycrm
+        connection.post('/Login', credentials).body
+      end
+
+      def credentials
+        %w(username password).each_with_object({}) do |f, o|
+          o[f] = Mycrm.configuration.send(f)
+        end
+      end
+
+      def session
+        @token = token
+        yield if block_given?
+      ensure
+        @token = nil
+      end
+    end
+
+    # private module to be extended
+    module ExtendedMethods
+
+      def connection
+        Mycrm::Connectable.connection do |faraday|
+          faraday.headers['Authorization'] = "Bearer #{skim(Mycrm::Connectable.token)}"
+        end
+      end
+
+      def respond(response)
+        raise ResponseError, skim(response.body) unless response.success?
+        raise ResponseError, 'Not found' if 'null'.eql?(skim(response.body))
+        parse(response.body)
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      rescue JSON::ParserError
+        raise ResponseError, "#{skim(body)} is not in a valid format"
+      end
+
+      def skim(string)
+        string.to_s.gsub(/\A"|"\Z/, '')
+      end
+
+      %w(get post put delete).each do |method|
+        define_method method do |uri, body = {}, query = {}|
+          response = connection.send(method, uri, query) do |req|
+            req.headers['Content-Type'] = 'application/json'
+            req.body = JSON.generate(body)
+            req.options.timeout = 120
+            req.options.open_timeout = 20
+          end
+          respond(response)
+        end
+      end
+    end
+  end
+end

data/lib/mycrm/core_ext.rb

@@ -0,0 +1,7 @@
+require 'mycrm/core_ext/string'
+require 'mycrm/core_ext/hash'
+
+String.include Mycrm::CoreExt::String
+Symbol.include Mycrm::CoreExt::String
+
+Hash.include Mycrm::CoreExt::Hash

data/lib/mycrm/core_ext/address.rb

@@ -0,0 +1,26 @@
+module Mycrm
+  module CoreExt
+    class Address
+      FIELDS = [:formatted, :street, :suburb, :state, :postcode, :country]
+
+      attr_reader *FIELDS
+
+      alias to_s formatted
+
+      def initialize(formatted, locale = :en_au)
+        @formatted = formatted
+        expand(locale)
+      end
+
+      def to_h
+        FIELDS.reject{ |f| f == :formatted }.each_with_object({}){ |f, out| out[f] = send(f) }
+      end
+
+      private
+
+      def expand(locale)
+        @street, @suburb, @state, @postcode, @country = *formatted.split(',').map(&:strip)
+      end
+    end
+  end
+end

data/lib/mycrm/core_ext/hash.rb

@@ -0,0 +1,28 @@
+module Mycrm
+  module CoreExt
+    module Hash
+      def symbolize_keys_deep!
+        self.replace modify_keys_deep(:to_sym)
+      end
+
+      def stringify_keys_deep!
+        self.replace modify_keys_deep(:to_s)
+      end
+
+      def modify_keys_deep(method = :to_sym )
+        self.each_with_object({}) do |(key, value), copy|
+          copy[key.send(method)] = value.kind_of?(Hash) ? value.modify_keys_deep(method) : value
+        end
+      end
+
+      def depp_merge(newhash)
+        return self.dup unless newhash
+        # merger = -> (key, oldval, newval) { oldval.is_a? Hash ? oldval.recursive_merge(newval) : newval } # not working :(
+        new_hash = (newhash.keys - keys).each_with_object({}) { |k, nh| nh[k] = newhash[k] }
+        self.each_with_object(new_hash) do |(key, value), nh|
+          nh[key] = value.kind_of?(Hash) ? value.depp_merge(newhash[key]) : (newhash[key] || value)
+        end
+      end
+    end
+  end
+end