abenity_ruby 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9404be5d05526d6e087b2225f4f9bc2ed761e3f07f6b0b2dbd9bbccc28f0aaa
+  data.tar.gz: 6128f55f43debfcfc97dc120e62401397e22fbff122cacbb5e3f991a1cc01bcb
+SHA512:
+  metadata.gz: cf35f7875a1354090183a54ce60f4922dff6ff36daf12e25e6e3f460d5a6c2a08977f1932ce2be51b7f3a17f9ba8fae347b096f88716352da9efa8889546e068
+  data.tar.gz: 734169422eb10b3a5b400263e7b80fea97ee40e6b0157e6202ba10faef4692d1bf6b9a47a95e466828352bcf37724dd82ecda9c5abe67e662850425f7f86481e

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in abenity_ruby.gemspec
+gemspec
+
+gem 'nokogiri', '1.8.2'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    abenity_ruby (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  abenity_ruby!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  nokogiri (= 1.8.2)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Roland Creative Group
+
+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,29 @@
+# AbenityRuby
+
+A Ruby library for using the Abenity API.
+
+You can find the full API documentation in the [official documentation](http://api.abenity.com/documentation).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abenity_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abenity_ruby
+
+## Usage
+
+### See examples folder
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+

data/abenity_ruby.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "abenity_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "abenity_ruby"
+  spec.version       = AbenityRuby::VERSION
+  spec.authors       = ["Brent Linville"]
+  spec.email         = ["webmaster@abenity.com"]
+
+  spec.summary       = %q{A Ruby library for using the Abenity API.}
+  spec.description   = %q{A Ruby library for using the Abenity API.}
+  spec.homepage      = "https://github.com/Abenity/abenity-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "abenity_ruby"
+
+# 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(__FILE__)

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/examples/deactivate_member.rb

@@ -0,0 +1,18 @@
+require "abenity_ruby"
+
+ApiClient = AbenityRuby::ApiClient.new(
+  "api_username",
+  "api_password",
+  "api_key"
+)
+
+results = ApiClient.deactivate_member('client_user_id');
+
+if results['status'] == 'ok'
+  puts "Success!"
+else
+  puts "There were some errors: \n"
+  results['error'].each do |key, value|
+    puts "#{key}: #{value} \n"
+  end
+end

data/examples/reactivate_member.rb

@@ -0,0 +1,18 @@
+require "abenity_ruby"
+
+ApiClient = AbenityRuby::ApiClient.new(
+  "api_username",
+  "api_password",
+  "api_key"
+)
+
+results = ApiClient.reactivate_member('client_user_id');
+
+if results['status'] == 'ok'
+  puts "Success!"
+else
+  puts "There were some errors: \n"
+  results['error'].each do |key, value|
+    puts "#{key}: #{value} \n"
+  end
+end

data/examples/sso_member.rb

@@ -0,0 +1,40 @@
+require "abenity_ruby"
+require "date"
+require "time"
+
+ApiClient = AbenityRuby::ApiClient.new(
+  "api_username",
+  "api_password",
+  "api_key"
+)
+
+member_info = {
+  "creation_time" => (DateTime.now).strftime('%FT%T%:z'),
+  "salt" => rand(0..100000),
+  "send_welcome_email" => "1",
+  "client_user_id" => "1",
+  "email" => "john.smith@acme.com",
+  "firstname" => "John",
+  "lastname" => "Smith",
+  "address" => "2134 Main Street",
+  "city" => "Irvine",
+  "state" => "CA",
+  "zip" => "92620",
+  "country" => "US",
+  "phone" => "234-234-2345",
+  "position" => "NA"
+}
+
+results = ApiClient.sso_member(
+  member_info,
+  File.read("file_path_to_private_key")
+)
+
+if results['status'] == 'ok'
+  puts "Success!  Token URL: #{results['data']['token_url']}"
+else
+  puts "There were some errors: \n"
+  results['error'].each do |key, value|
+    puts "#{key}: #{value} \n"
+  end
+end

data/lib/abenity_ruby.rb

@@ -0,0 +1,218 @@
+require "abenity_ruby/version"
+require "openssl"
+require "base64"
+require "net/https"
+require "uri"
+require "json"
+require "nokogiri"
+require "cgi"
+
+module AbenityRuby
+  class ApiClient
+    PUBLIC_KEY = "-----BEGIN RSA PUBLIC KEY-----\n" +
+      "MIGJAoGBALw1VRlS2vYgeIWhjyz+oUaZk4h7AC+BLgUxdZnzVBzyWQCVmv17XvXG\n" +
+      "fg+Aqv5Ltix8K37VcrKjleasnJo1R79pGm0H3c0WfpGgXMTGB+mSijFwelZw/L4d\n" +
+      "vl7SvA8MEDrN/KthGPy4r/UeV4USvi/y78ducmaIWg0naF9lefpDAgMBAAE=\n" +
+      "-----END RSA PUBLIC KEY-----"
+
+    # Public: Initialize an API Client
+    #
+    # api_username - A String of the API username
+    # api_password - A String of the API password
+    # api_key - A String of the API key
+    # version - An Integer naming the API version number
+    # environment - A String naming the environment
+    # timeout - An Integer specifiying the timeout on a request
+    def initialize(api_username, api_password, api_key, version = 2, environment = 'live', timeout = 10)
+      @api_username = api_username
+      @api_password = api_password
+      @api_key = api_key
+      @version = version
+
+      if environment == 'live'
+        @api_url = 'https://api.abenity.com'
+      else
+        @api_url = 'https://sandbox.abenity.com'
+      end
+
+      @timeout = timeout
+
+      @encrypt_cipher = OpenSSL::Cipher.new("DES3")
+      @encrypt_cipher.encrypt
+
+      @triple_des_key = @encrypt_cipher.random_key
+      @triple_des_iv = @encrypt_cipher.random_iv
+    end
+
+    # Public: Send a HTTP request to the API
+    #
+    # api_method - The API method to be called
+    # http_method - The HTTP method to be used (GET, POST, PUT, DELETE, etc.)
+    # data - Any data to be sent to the API
+    #
+    # Returns a data-object of the response
+    def send_request(api_method, http_method = 'GET', data = nil)
+      if data.is_a?(Hash)
+        data['api_username'] = @api_username
+        data['api_password'] = @api_password
+        data['api_key'] = @api_key
+
+        post_data = data.map{|k,v| "#{CGI::escape(k)}=#{CGI::escape(v)}"}.join('&')
+      else
+        post_data = sprintf(
+            "api_username=%s&api_password=%s&api_key=%s&%s",
+            CGI::escape(@api_username),
+            CGI::escape(@api_password),
+            CGI::escape(@api_key),
+            data
+        )
+      end
+
+      uri = URI.parse("#{@api_url}/v#{@version}/client#{api_method}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = http_method == 'GET' ? Net::HTTP::Get.new(uri.request_uri) : Net::HTTP::Post.new(uri.request_uri)
+      request.body = !data.nil? ? post_data : ''
+
+      request.initialize_http_header({
+        "User-Agent" => "abenity/abenity-ruby v1"
+      })
+
+      response = http.request(request)
+
+      return parse_response(response.body)
+    end
+
+    # Public: Single Sign-On a member
+    #
+    # member_profile - A hash of key/value pairs that describes the member
+    # private_key - Your RSA private key, used to sign your message
+    #
+    # Returns the raw API response
+    def sso_member(member_profile, private_key)
+      # Convert member profile hash to a HTTP query string
+      payload_string = member_profile.map{|k,v| "#{k}=#{v}"}.join('&')
+
+      # URL encode and Base 64 encode the IV
+      iv_urlencoded = "#{CGI::escape(Base64.strict_encode64(@triple_des_iv))}decode"
+
+      payload = encrypt_payload(payload_string, @triple_des_iv)
+      cipher = encrypt_cipher(@triple_des_key)
+      signature = sign_message(payload, private_key)
+
+      data = sprintf(
+          "Payload=%s&Cipher=%s&Signature=%s&Iv=%s",
+          payload,
+          cipher,
+          signature,
+          iv_urlencoded
+      )
+
+      return send_request('/sso_member.json', 'POST', data)
+    end
+
+    # Public: Deactivate a Member
+    #
+    # client_user_id - The unique Client User ID for the member
+    # send_notification - Set to true to send a notification email
+    #
+    # Returns the raw API response
+    def deactivate_member(client_user_id, send_notification = 'false')
+      data = {
+        'client_user_id' => client_user_id,
+        'send_notification' => send_notification
+      }
+
+      return send_request('/deactivate_member.json', 'POST', data)
+    end
+
+    # Public: Reactivate a Member
+    #
+    # client_user_id - The unique Client User ID for the member
+    # send_notification - Set to true to send a notification email
+    #
+    # Returns the raw API response
+    def reactivate_member(client_user_id, send_notification = 'false')
+      data = {
+        'client_user_id' => client_user_id,
+        'send_notification' => send_notification
+      }
+
+      return send_request('/reactivate_member.json', 'POST', data)
+    end
+
+    private
+
+    # Private: Parse the API response
+    #
+    # response - The response string
+    # format - The format of the response to parse
+    #
+    # Returns the parsed response as a data hash
+    def parse_response(response, format = 'json')
+      result = nil
+
+      if format == 'json'
+        result = JSON.parse(response)
+      elsif format == 'xml'
+        result = Nokogiri::XML(response)
+      end
+
+      return result
+    end
+
+    # Private: Symmetrically encrypt a string of information
+    #
+    # payload_string - An input string
+    # iv - An initialization vector for Triple-DES in CBC mode
+    #
+    # Returns a base64-encoded and url-encoded representation of the $payload_string
+    def encrypt_payload(payload_string, iv)
+      payload_urlencoded = ''
+
+      encrypted = @encrypt_cipher.update(payload_string) + @encrypt_cipher.final
+      encypted_base64 = Base64.strict_encode64(encrypted)
+      payload_urlencoded = "#{CGI::escape(encypted_base64)}decode"
+
+      return payload_urlencoded
+    end
+
+    # Private: Asymmetrically encrypt a symmetrical encryption key
+    #
+    # triple_des_key - A Triple DES (3DES) encryption key
+    #
+    # Returns a base64-encoded and url-encoded representation of the $triple_des_key
+    def encrypt_cipher(triple_des_key)
+      triple_des_key_urlencoded = ''
+
+      key = OpenSSL::PKey::RSA.new(PUBLIC_KEY)
+      encrypted_triple_des = key.public_encrypt(triple_des_key)
+      encrypted_base64 = Base64.strict_encode64(encrypted_triple_des)
+      triple_des_key_urlencoded = "#{CGI::escape(encrypted_base64)}decode"
+
+      return triple_des_key_urlencoded
+    end
+
+    # Private: Sign a message using a private RSA key
+    #
+    # payload - The message to be signed
+    # private_key - An RSA private key
+    #
+    # Returns a base64-encoded and url-encoded hash of the $payload_string
+    def sign_message(payload, private_key)
+      signature_urlencoded = ''
+
+      key = OpenSSL::PKey::RSA.new(private_key)
+
+      payload_decoded = CGI::unescape(payload.chomp('decode'))
+
+      signature = key.sign(OpenSSL::Digest::MD5.new, payload_decoded)
+      signature_base64 = Base64.strict_encode64(signature)
+      signature_urlencoded = "#{CGI::escape(signature_base64)}decode"
+
+      return signature_urlencoded
+    end
+  end
+end

data/lib/abenity_ruby/version.rb

@@ -0,0 +1,3 @@
+module AbenityRuby
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: abenity_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Brent Linville
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A Ruby library for using the Abenity API.
+email:
+- webmaster@abenity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- abenity_ruby.gemspec
+- bin/console
+- bin/setup
+- examples/deactivate_member.rb
+- examples/reactivate_member.rb
+- examples/sso_member.rb
+- lib/abenity_ruby.rb
+- lib/abenity_ruby/version.rb
+homepage: https://github.com/Abenity/abenity-ruby
+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.7.5
+signing_key: 
+specification_version: 4
+summary: A Ruby library for using the Abenity API.
+test_files: []