northern911-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcf682473366f0eb08051e0a6ad974cfa82af4c26b157c890ca94e316910b14f
+  data.tar.gz: 209eee0e5c0321a7e3c27296dbe76dee694b442bd23caff8d52474a2ac343c51
+SHA512:
+  metadata.gz: 9401357e49bdde01fccca9cd116d27b82dcd72e1abcab46ea31c76a4b59d1fc26c6fbb3f68c130d9e87c47fa540052416e59cf807b9300b4836c3c9117676c82
+  data.tar.gz: 17cb262972dd0c02cb81dd3f66a26c47057b97c9fda208d264922bbd111ef2190bee209ea2cd4255e2a7259b4cf557fc5a3e6111f4abc0ab170762b9c6f91eea

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at julien.chabanon@modulis.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Northern911Api.gemspec
+gemspec
+
+gem 'savon'
+gem 'pry-byebug'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 CHABANON Julien
+
+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/Northern911Api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Northern911Api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Northern911Api"
+  spec.version       = Northern911Api::VERSION
+  spec.authors       = ["CHABANON Julien"]
+  spec.email         = ["julien.chabanon@modulis.ca"]
+
+  spec.summary       = %q{A simple API wrapper for Northern911 SOAP API}
+  spec.description   = %q{This API wrapper is meant to provide a rails friendly configurable api wrapper to access Northern911's SOAP based API using Savon gem.}
+  spec.homepage      = "http://github.com/modulis/Northern911-API-WRAPPER"
+  spec.license       = "MIT"
+
+  spec.name          = "northern911-client"
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "savon", "~> 2.x"
+end

data/README.md

@@ -0,0 +1,87 @@
+# Northern911Api
+
+A simple Rails friendly API wrapper for Northern911Api's SOAP based API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Northern911Api', git: 'https://github.com/modulis/Northern911-API-WRAPPER.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Northern911Api
+
+## Usage
+### Configuration
+First you must configure Northern911Api or you won't be able to make requests.
+```ruby
+Northern911Api.configure do |config|
+  config.vendor_code = '427' # Your api username given to you by Northern911Api
+  config.soap_passcode = '#9mB@j3X' # Your secret api key given to you by Northern911Api
+  config.sandbox = false # Optional. True by default, you must set it to live manually.
+end
+```
+
+### Building the client
+You can create a client which will inheret Northern911Api configuration automatically using
+```ruby
+client = Northern911Api::Client.new
+```
+
+If you would like to change the configuration for a specific client you'll have to do so manually:
+```ruby
+client.configuration.sandbox = false # sets this client to live mode
+```
+
+### Some examples
+```ruby
+client = Northern911Api::Client.new
+client.addor_update_customer(customer: {...}) # see Customer fields below
+client.query_customer({phone_number: '5142842020'})
+client.delete_customer({phone_number: '5142842020'})
+```
+
+### Customer object should contains
+```ruby
+:city, :first_name, :last_name, :other_address_info, :phone_number, :realm_id, :postal_code_zip, :province_state, :street_name, :street_number, :suite_apt
+```
+
+### Available methods
+```ruby
+[:addor_update_customer, :delete_customer, :query_customer, :get_vendor_dump_url, :verify_customer]
+```
+
+### Official API doc
+https://addressinfo.northern911.com/soapapidocs/
+
+
+### Convenience methods
+Northern911Api has a few convenience methods to use in your code:
+```ruby
+Northern911Api.configure do |config|
+  config.vendor_code = '427' # Your api username given to you by Northern911Api
+  config.soap_passcode = '#9mB@j3X' # Your secret api key given to you by Northern911Api
+  config.sandbox = false # Optional. True by default, you must set it to live manually.
+end
+```
+
+## Development
+
+You have access to a developer console to use the gem interactively by running `bin/console` from the project directory.
+Please write specs for any additions, and use shared examples when possible.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/modulis/Northern911-API-WRAPPER.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "Northern911Api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/Northern911Api.rb

@@ -0,0 +1,34 @@
+require "Northern911Api/version"
+require "Northern911Api/configuration"
+require 'Northern911Api/client'
+require 'Northern911Api/model/customer'
+
+module Northern911Api
+  class << self
+    attr_reader :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.mode
+    configuration.sandbox ? :sandbox : :live
+  end
+
+  def self.sandbox?
+    configuration.sandbox
+  end
+
+  def self.live?
+    !configuration.sandbox
+  end
+end

data/lib/Northern911Api/client.rb

@@ -0,0 +1,46 @@
+require 'savon'
+
+module Northern911Api
+  class Client
+    attr_reader :configuration, :methods
+
+    def initialize
+      @configuration = Northern911Api.configuration
+      @savon = savon_client
+      @methods = savon_client.operations
+    end
+
+    def method_missing(method_name, *args, &block)
+      if methods.include? method_name
+        params = {}
+        params = (args.first || {}).merge(hash: auth_string)
+        params.merge!(vendor_code: configuration.vendor_code)
+        # because savon do not support Customer object declared in WSDL as a complex type
+        if(method_name == :addor_update_customer)
+          raw_xml = "<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' xmlns:ns1='http://schemas.datacontract.org/2004/07/' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns2='http://tempuri.org/'><SOAP-ENV:Body><ns2:AddorUpdateCustomer><ns2:customer><ns1:CITY>#{params[:customer][:city]}</ns1:CITY><ns1:ENHANCED_CAPABLE>Y</ns1:ENHANCED_CAPABLE><ns1:FIRST_NAME>#{params[:customer][:first_name]}</ns1:FIRST_NAME><ns1:LAST_DATETIME_MODIFIED xsi:nil='true'/><ns1:LAST_DATETIME_MODIFIED_UNIXTIME xsi:nil='true'/><ns1:LAST_NAME>#{params[:customer][:last_name]}</ns1:LAST_NAME><ns1:OTHER_ADDRESS_INFO>#{params[:customer][:other_address_info]}</ns1:OTHER_ADDRESS_INFO><ns1:PHONE_NUMBER>#{params[:customer][:phone_number]}</ns1:PHONE_NUMBER><ns1:POSTAL_CODE_ZIP>#{params[:customer][:postal_code_zip]}</ns1:POSTAL_CODE_ZIP><ns1:PROVINCE_STATE>#{params[:customer][:province_state]}</ns1:PROVINCE_STATE><ns1:STREET_NAME>#{params[:customer][:street_name]}</ns1:STREET_NAME><ns1:STREET_NUMBER>#{params[:customer][:street_number]}</ns1:STREET_NUMBER><ns1:SUITE_APT>#{params[:customer][:suite_apt]}</ns1:SUITE_APT><ns1:VENDOR_CODE>#{configuration.vendor_code}</ns1:VENDOR_CODE></ns2:customer><ns2:hash>#{params[:hash]}</ns2:hash></ns2:AddorUpdateCustomer></SOAP-ENV:Body></SOAP-ENV:Envelope>"
+          @savon.call(method_name, xml: raw_xml)
+        elsif(method_name == :query_customer)
+          raw_xml = "<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' xmlns:ns1='http://tempuri.org/'><SOAP-ENV:Body><ns1:QueryCustomer><ns1:vendorCode>#{configuration.vendor_code}</ns1:vendorCode><ns1:phoneNumber>#{params[:phone_number]}</ns1:phoneNumber><ns1:hash>#{params[:hash]}</ns1:hash></ns1:QueryCustomer></SOAP-ENV:Body></SOAP-ENV:Envelope>"
+          @savon.call(method_name, xml: raw_xml)
+        elsif(method_name == :delete_customer)
+          raw_xml = "<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/' xmlns:ns1='http://tempuri.org/'><SOAP-ENV:Body><ns1:DeleteCustomer><ns1:vendorCode>#{configuration.vendor_code}</ns1:vendorCode><ns1:phoneNumber>#{params[:phone_number]}</ns1:phoneNumber><ns1:hash>#{params[:hash]}</ns1:hash></ns1:DeleteCustomer></SOAP-ENV:Body></SOAP-ENV:Envelope>"
+          @savon.call(method_name, xml: raw_xml)
+        else
+          @savon.call(method_name, message: params)
+        end
+      else
+        raise NoMethodError, "#{method_name} is not a valid api endpoint!"
+      end
+    end
+
+    private
+    def savon_client
+      Savon::Client.new wsdl: configuration.wsdl
+    end
+
+    def auth_string
+      gmdate = Time.now.strftime('%Y%m%d')
+      Digest::MD5.hexdigest(configuration.vendor_code + configuration.soap_passcode + gmdate)
+    end
+  end
+end

data/lib/Northern911Api/configuration.rb

@@ -0,0 +1,20 @@
+module Northern911Api
+  class Configuration
+    attr_accessor :vendor_code, :soap_passcode, :sandbox, :wsdl
+
+    def initialize(params = {})
+      @vendor_code = params[:vendor_code]
+      @soap_passcode = params[:soap_passcode]
+      @sandbox = params[:sandbox] || true
+      @wsdl = @sandbox ? sandbox_url : live_url
+    end
+
+    def sandbox_url
+      'https://soapdev.northern911.com/soap/Service.svc?wsdl'
+    end
+
+    def live_url
+      'https://addressinfo.northern911.com/soap/Service.svc?wsdl'
+    end
+  end
+end

data/lib/Northern911Api/model/customer.rb

@@ -0,0 +1,32 @@
+require 'savon'
+
+module Northern911Api
+	class Customer
+		attr_reader :configuration
+
+		extend Savon::Model
+		#client wsdl: "https://soapdev.northern911.com/soap/Service.svc?xsd=xsd2"
+		#client wsdl: "https://soapdev.northern911.com/soap/Service.svc?wsdl"
+
+	    def initialize(*operations)
+	      @configuration = Northern911Api.configuration
+	      self.class.client wsdl: configuration.wsdl
+    	  operations.each { |operation| self.class.operations operation }
+	    end
+	  	
+	  	operations :CITY, :CITY
+	  	operations :ENHANCED_CAPABLE, :ENHANCED_CAPABLE
+	  	operations :FIRST_NAME, :FIRST_NAME
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	  	# operations :authenticate, :find_user
+	end
+end

data/lib/Northern911Api/version.rb

@@ -0,0 +1,3 @@
+module Northern911Api
+  VERSION = "0.1.1"
+end

data/spec/Northern911Api_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Northern911Api do
+  it 'has a version number' do
+    expect(Northern911Api::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'Northern911Api'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: northern911-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- CHABANON Julien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.x
+description: This API wrapper is meant to provide a rails friendly configurable api
+  wrapper to access Northern911's SOAP based API using Savon gem.
+email:
+- julien.chabanon@modulis.ca
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Northern911Api.gemspec
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/Northern911Api.rb
+- lib/Northern911Api/client.rb
+- lib/Northern911Api/configuration.rb
+- lib/Northern911Api/model/customer.rb
+- lib/Northern911Api/version.rb
+- spec/Northern911Api_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/modulis/Northern911-API-WRAPPER
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple API wrapper for Northern911 SOAP API
+test_files: []