onelogin 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c91052998d05d2e77aa306969a4df08d6e33c07b
-  data.tar.gz: 47b18c4ac2681e82d16cf4b591545e410f185634
+  metadata.gz: 58c499d12ba910854c224b2e7280e0705ece7eef
+  data.tar.gz: a76418a9f64073ee882bcc0c0488d396d83f831e
 SHA512:
-  metadata.gz: 70c17995bcc43243a87e6fdaa3061c992de2bc6209d980707fa5f624a611a43a962c5fe9810e0f395b884b6cab1bc42664596c9e726cdc28bb4e663b842ff582
-  data.tar.gz: 11b280b60df068f7e6585839c1e6ea3c7f60f679297d7f44d70a22f0ac172b0260c5a4ec69775239f2f3eea030e006cbf17332d1c8a86466bf8628daf2c66bc1
+  metadata.gz: 33852679c25f500dc0957abc8038fe22d9df7410bbf87a48c33e48c4ead2458f4424714089a87feda5f789715e4989cbebbb762ca9dd7e8c8940bbe683c2eb7f
+  data.tar.gz: 3962ba7ca01cff4b33c80865d6eae2fb7b58dff1749bb97b51cf59dcbc4b253944b831654e0f38b63d53a4ef1690db0098c40721b1b182cd2e6a76e1ff7efa7a

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+.DS_Store
+.rspec_status

data/.travis.yml

@@ -1,4 +1,6 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.11.2
+  - 1.9.3
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant 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.
+## Our Pledge
 
-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.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,24 +43,32 @@ 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.
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at chandra@cloudfactory.com. All
+reported by contacting the project team at richardchetwynd@gmail.com. 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.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
 
-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]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.com'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in onelogin.gemspec
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in onelogin-ruby-sdk.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010-2017 OneLogin, Inc.
+
+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

@@ -1,7 +1,12 @@
-# Onelogin
+# OneLogin Ruby SDK
+
+This SDK will let you execute all the API methods, version/1, described
+at https://developers.onelogin.com/api-docs/1/getting-started/dev-overview.
+
+The toolkit is hosted on github. You can download it from:
+* Lastest release: https://github.com/onelogin/onelogin-ruby-sdk/releases/latest
+* Master repo: https://github.com/onelogin/onelogin-ruby-sdk/tree/master
 
-This Gem use OneLogin’s product API to interact with your organization’s data and to develop third-party apps that incorporate and build upon OneLogin’s core product features.
-For more info visit [OneLogin Api Doc](https://developers.onelogin.com/docs)
 
 ## Installation
 
@@ -19,9 +24,296 @@ Or install it yourself as:
 
     $ gem install onelogin
 
+
+### Dependencies
+
+* httparty
+
+## Getting started
+
+You'll need a OneLogin account and a set of API credentials before you get started.
+
+If you don't have an account you can [sign up for a free developer account here](https://www.onelogin.com/developer-signup).
+
+|||
+|---|---|
+|client_id|Required: A valid OneLogin API client_id|
+|client_secret|Required: A valid OneLogin API client_secret|
+|region| Optional: `us` or `eu`. Defaults to `us`   |
+|max_results| Optional: Defaults to 1000  |
+
+```ruby
+require 'onelogin'
+
+client = OneLogin::Api::Client.new(
+    client_id: '',
+    client_secret:'',
+    region: 'us'
+)
+
+# Now you can make requests
+client.get_users
+```
+
+For all methods see Rubydoc of this SDK published at:
+http://www.rubydoc.info/github/onelogin/onelogin-ruby-sdk
+
+
 ## Usage
 
-TODO: Write usage instructions here
+### Errors and exceptions
+
+OneLogin's API can return 400, 401, 403 or 404 when there was any issue executing the action. When that happens, the methods of the SDK will include error and errorMessage in the client. Use `error` and `error_description` of the Client to retrieve them.
+
+```ruby
+users = client.get_users
+
+if users.nil?
+    puts client.error
+    puts client.error_description
+end
+```
+
+### Authentication
+
+By default methods call internally to `get_access_token` if there is no valid access_token. You can also get tokens etc directly if needed.
+
+```ruby
+# Get an AccessToken
+token = client.get_access_token
+
+# Refresh an AccessToken
+token2 = client.regenerate_token
+
+# Revoke an AccessToken
+token3 = client.get_access_token
+```
+
+### Paging
+All OneLogin API endpoints that support paging are returned as enumerations to save you keeping track of the paging cursor.
+
+User `take` to limit the results or get all results by enumerating.
+
+e.g.
+```ruby
+# List the first name of all users
+client.get_users.each do |user|
+    puts user.firstname
+end
+
+# List the first name of all users starting with the 2nd user
+# `each` accepts a start param to skip first x results
+client.get_users.each(1) do |user|
+    puts user.firstname
+end
+
+# List the first 5 users with the name of Joe
+client.get_users(firstname: 'Joe').take(5).each do |user|
+    puts "#{user.firstname} #{user.lastname}"
+end
+
+# Get 10 event ids
+client.get_events.take(10).map{|event| event.id }
+
+# Get all roles
+client.get_roles.to_a
+```
+
+For safety where some collections (e.g. `get_events`) have large numbers of resources there is a
+limit of 1000 total results returned. You can override this with the `max_results` param during Client initialization.
+
+```
+client = OneLogin::Api::Client.new(
+    client_id: '',
+    client_secret:'',
+    max_results: 50000
+)
+
+client.get_events.map {|event| event.id}
+```
+
+
+
+### Available Methods
+
+```ruby
+# Get rate limits
+rate_limits = client.get_rate_limits
+
+# Get Custom Attributes
+custom_global_attributes = client.get_custom_attributes
+
+# Get Users with no query parameters
+users = client.get_users
+
+# Get Users with query parameters
+query_parameters = {
+    email: "user@example.com"
+}
+users_filtered = client.get_users(query_parameters)
+
+query_parameters = {
+    email: "usermfa@example.com"
+}
+users_filtered2 = client.get_users(query_parameters)
+
+# Get Users with limit
+query_parameters = {
+    limit: 3
+}
+users_filtered_limited = client.get_users(query_parameters)
+
+# Only return the firstname and email fields for each user
+client.get_users(fields: 'email,firstname').each do |user|
+    puts "#{user.firstname} - #{user.email}"
+end
+
+# Get User by id
+user = client.get_user(users_filtered.first.id)
+user_mfa = client.get_user(users_filtered2.first.id)
+
+# Update User with specific id
+user = client.get_user(user.id)
+update_user_params = user.get_user_params
+update_user_params["firstname"] = 'modified_firstname'
+user = client.update_user(user.id, update_user_params)
+user = client.get_user(user.id)
+
+# Get Global Roles
+roles = client.get_roles
+
+# Get Role
+role = client.get_role(1234)
+
+# Assign & Remove Roles On Users
+role_ids = [
+    1234, 5678
+]
+result = client.assign_role_to_user(user.id, role_ids)
+role_ids.pop
+result = client.remove_role_from_user(user.id, role_ids)
+user = client.get_user(user.id)
+
+# Sets Password by ID Using Cleartext
+password = "Aa765431-XxX"
+result = client.set_password_using_clear_text(user.id, password, password)
+
+# Sets Password by ID Using Salt and SHA-256
+password = "Aa765432-YyY"
+salt = "11xxxx1"
+
+require 'digest'
+sha256 = Digest::SHA256.new
+hashed_salted_password = sha256.hexdigest("#{pw}#{salt}")
+result = client.set_password_using_hash_salt(user_mfa.id, hashed_salted_password, hashed_salted_password, "salt+sha256", salt)
+
+ Set Custom Attribute Value to User
+customAttributes = {
+    custom_global_attributes[0]=> "xxxx",
+    custom_global_attributes[1]=> "yyyy"
+}
+result = client.set_custom_attribute_to_user(34687020, customAttributes)
+
+# Log Out User
+result = client.log_user_out(user.id)
+
+# Lock User
+result = client.lock_user(user.id, 5)
+
+# Get User apps
+apps = client.get_user_apps(user.id)
+
+# Get User Roles
+role_ids = client.get_user_roles(user.id)
+
+# Create user
+new_user_params = {
+    email: "testcreate_1@example.com",
+    firstname: "testcreate_1_fn",
+    lastname: "testcreate_1_ln",
+    username: "testcreate_1@example.com"
+}
+created_user = client.create_user(new_user_params)
+
+# Delete User
+result = client.delete_user(created_user.id)
+
+# Create Session Login Token
+session_login_token_params = {
+    username_or_email: "user@example.com",
+    password: "Aa765431-XxX",
+    subdomain: "example-onelogin-subdomain"
+}
+session_token_data = client.create_session_login_token(session_login_token_params)
+
+# Create Session Login Token MFA , after verify
+session_login_token_mfa_params = {
+    username_or_email: "usermfa@example.com",
+    password: "Aa765432-YyY",
+    subdomain: "example-onelogin-subdomain"
+}
+session_token_mfa_data = client.create_session_login_token(session_login_token_mfa_params)
+otp_token = "000000" # We get this value from OTP device
+session_token_data2 = client.get_session_token_verified(session_token_mfa_data.devices[0].id,session_token_mfa_data.state_token, otp_token)
+
+# Get EventTypes
+event_types = client.get_event_types
+
+# Get Events
+events = client.get_events
+
+query_events_params = {
+    limit: 2
+}
+events_limited = client.get_events(query_events_params)
+
+# Get Event
+event = client.get_event(events[0].id)
+
+# Create Event
+new_event_params = {
+    event_type_id: "000",
+    account_id: "00000",
+    actor_system: "00",
+    user_id: "00000000",
+    user_name: "test_event",
+    custom_message: "test creating event from python :)"
+}
+result = client.create_event(new_event_params)
+
+# Get Filtered Events
+query_events_params = array(
+  user_id: "00000000"
+)
+events = client.get_events(query_events_params)
+
+# Get Groups
+groups = client.get_groups
+
+# Get Group
+group = client.get_group(groups.first.id)
+
+# Get SAMLResponse directly
+app_id = "000000"
+saml_endpoint_response = client.get_saml_assertion("user@example.com", "Aa765431-XxX", app_id, "example-onelogin-subdomain")
+
+# Get SAMLResponse after MFA
+saml_endpoint_response2 = client.get_saml_assertion("usermfa@example.com", "Aa765432-YyY", app_id, "example-onelogin-subdomain")
+mfa = saml_endpoint_response2.mfa
+otp_token = "000000"
+saml_endpoint_response_after_verify = client.get_saml_assertion_verifying(app_id, mfa.devices[0].id, mfa.state_token, "78395727", nil)
+
+# Generate Invite Link
+url_link = client.generate_invite_link("user@example.com")
+
+# Send Invite Link
+sent = client.send_invite_link("user@example.com")
+
+#Get Apps to Embed for a User
+embed_token = "30e256c101cd0d2e731de1ec222e93c4be8a1572"
+apps = client.get_embed_apps("30e256c101cd0d2e731de1ec222e93c4be8a1572", "user@example.com")
+```
+
 
 ## Development
 
@@ -31,10 +323,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cmthakur/onelogin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/onelogin/onelogin-ruby-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Code of Conduct
+
+Everyone interacting in the OneLogin Ruby Sdk project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/onelogin/onelogin-ruby-sdk/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -11,4 +11,4 @@ require "onelogin"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here