forked from pdsphil/ruby-idology
Ruby interface to the IDology API
License
Unknown, MIT licenses found
Licenses found
Unknown
LICENSE
MIT
MIT-LICENSE
structuralartistry/ruby_idology
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
== Installation Reference the ruby_idology repo in the main project Gemfile. Make sure you have require 'false' set. Otherwise the gem will load and there is an issue with a nil value for Rails.env if the gem loads early. gem 'ruby_idology', :path => '~/Documents/programming/projects/ruby_idology', :require => false Create the path in the main project: app_root/config/ruby_idology. Copy the ruby_idology_config.yml.example to the directory above (remove .example of course!). Set the credentials as appropriate in the above yml file. When you want to access the gems functionlity, require it: "require 'ruby_idology'" == Notes This code has come straight from a production Rails app. It will soon be a Rails plugin, but for now, I suggest putting it in the lib/ directory of your Rails project. You must have a valid IDology account to test or use this API library. == ID Verification via IDology Assuming you have a local proxy setup to the development server - and the development server's IP is authorized to access the IDology API - here is a curl command to test whether or not the API is working correctly. In this example, the socks v5 proxy is using 'ssh -D localhost:1080' to setup a temporary proxy between the development machine and the development server. Note that the username / password must be correct. This curl command will perform a search for 'Mickey Mouse' - a valid test record in the IDology system curl -v --socks http://127.0.0.1:1080 -d username=test -d password=test -d firstName=mickey -d lastName=mouse -d address='15 MIDLAND AVE APT' -d city=paramus -d state=NJ -d zip=07652 https://web.idologylive.com/api/idlive.svc == Configuration The id_verification directory must contain a file called 'config.yml' using the following format: # IDology API username and password username: your_api_username password: your_api_password It is recommended that you symlink this file to the directory after deploy for security reasons. This file is also required for development mode - just fill with dummy data. == Tests To run tests cd to id_verification directory run 'rspec spec' == DK Notes to use: run irb load 'id_verification.rb' include API::Base include API::IDVerification # check if subject exists in idology system
About
Ruby interface to the IDology API
Resources
License
Unknown, MIT licenses found
Licenses found
Unknown
LICENSE
MIT
MIT-LICENSE
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published
Languages
- Ruby 100.0%