people-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66f771ab87ee148d6270557144373d1c35facace
+  data.tar.gz: 377b59a8ec4acbfa37fc94bbb2fb74fc109b31ee
+SHA512:
+  metadata.gz: a9cb33435af8531bb5387b9705660b551672466f54bca91dc9966800b695bc869684fde120bc6285a00ce34b78b6e97899053969db17fd046a31b980d73f214c
+  data.tar.gz: 99c8d0e6b4e15b3084018a47c1ef8cc1ab25683623ec99ecde3f91e5611c1694b34476cade4870a88d006821e35229af257a00a2df30a59a948a158c4d9291f1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+bin/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in people.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Raz Konforti
+
+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,63 @@
+# People Ruby bindings
+
+The People Ruby bindings provide a small SDK for convenient access to the People API from applications written in the Ruby language. 
+
+## Documentation
+
+[API Docs](http://www.konforti.net/slate)
+
+## Installation
+
+You don't need this source code unless you want to modify the gem. 
+If you just want to use the People Ruby bindings, you should run:
+
+``` bash
+$ gem install people
+```
+
+or with [Bundler](http://bundler.io)
+
+```ruby
+gem 'people'
+```
+
+If you want to build the gem from source:
+
+``` bash
+$ gem build people.gemspec
+```
+
+## Basic usage
+
+```ruby
+require "people"
+
+people = People::Client.new(
+  secret_key: "YOUR SECRET KEY",
+  domain: "YOUR People's installation path"
+)
+
+puts people.get_users
+```
+
+## Development
+
+If you want to build the gem from source:
+
+``` bash
+$ gem build people.gemspec
+```
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/konforti/people-ruby. 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).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/people.rb

@@ -0,0 +1,6 @@
+require 'people/version'
+require 'people/exception'
+require 'people/client'
+
+module People
+end

data/lib/people/api/v1.rb

@@ -0,0 +1,12 @@
+require 'json'
+require 'people/api/v1/persons'
+require 'people/api/v1/roles'
+
+module People
+  module Api
+    module V1
+      include People::Api::V1::Persons
+      include People::Api::V1::Roles
+    end
+  end
+end

data/lib/people/api/v1/persons.rb

@@ -0,0 +1,62 @@
+module People
+  module Api
+    module V1
+      module Persons
+
+        # Users list
+        def persons(*args)
+          path = '/api/v1/persons/'
+          path += "?search=#{args['search']}" if args.include? 'search'
+          path += "?limit=#{args['limit']}" if args.include? 'limit'
+          path += "?page=#{args['page']}" if args.include? 'page'
+          path += "?sort=#{args['sort']}" if args.include? 'sort'
+          get(path)
+        end
+
+        alias_method :get_persons, :persons
+        alias_method :get_users, :persons
+
+        # Get User.
+        def person(id)
+          path = "/api/v1/persons/#{id}"
+          get(path)
+        end
+
+        alias_method :get_person, :person
+        alias_method :get_user, :person
+
+        # Get the Current User
+        def current_person
+          jwt = cookies['people.jwt']
+          path = "/api/v1/persons/current/#{jwt}"
+          get(path)
+        end
+
+        alias_method :get_current_person, :current_person
+        alias_method :get_current_user, :current_person
+
+        def update_person(id, payload)
+          path = "/api/v1/persons/#{id}"
+          put(path, query: payload)
+        end
+
+        alias_method :update_user, :update_person
+
+        def person_add_role(id, role)
+          path = "/api/v1/persons/#{id}/roles"
+          post(path, query: role)
+        end
+
+        alias_method :user_add_role, :person_add_role
+
+        def person_remove_role(id, role)
+          path = "/api/v1/persons/#{id}/roles/#{role}"
+          delete(path)
+        end
+
+        alias_method :user_add_role, :person_add_role
+
+      end
+    end
+  end
+end

data/lib/people/api/v1/roles.rb

@@ -0,0 +1,22 @@
+module People
+  module Api
+    module V1
+      module Roles
+        def roles
+          path = 'api/v1/roles/'
+          get(path)
+        end
+
+        # alias_method :get_roles, :roles
+
+        def role(rid)
+          path = "api/v1/roles/#{rid}"
+          get(path)
+        end
+
+        alias_method :get_role, :role
+
+      end
+    end
+  end
+end

data/lib/people/client.rb

@@ -0,0 +1,12 @@
+require 'httparty'
+require 'uri'
+require 'people/http_proxy'
+require 'people/initializer'
+
+module People
+  class Client
+    include HTTParty
+    include People::Initializer
+    include People::HttpProxy
+  end
+end

data/lib/people/exception.rb

@@ -0,0 +1,39 @@
+module People
+
+  class Exception < StandardError;
+  end
+
+  class Unauthorized < People::Exception;
+  end
+
+  class NotFound < People::Exception;
+  end
+
+  class Unsupported < People::Exception;
+  end
+
+  class ServerError < People::Exception;
+  end
+
+  class BadRequest < People::Exception;
+  end
+
+  class MissingUserId < People::Exception;
+  end
+
+  class MissingConnectionId < People::Exception;
+  end
+
+  class AccessDenied < People::Exception;
+  end
+
+  class InvalidParameter < People::Exception;
+  end
+
+  class InvalidCredentials < People::Exception;
+  end
+
+  class InvalidApiNamespace < People::Exception;
+  end
+
+end

data/lib/people/http_proxy.rb

@@ -0,0 +1,31 @@
+module People
+  module HttpProxy
+    %i(get post put patch delete).each do |method|
+      define_method(method) do |path, body = {}|
+        safe_path = URI.escape(path)
+        body = body.delete_if { |_, v| v.nil? }
+        if method == :get
+          result = self.class.send(method, safe_path, query: body)
+        else
+          result = self.class.send(method, safe_path, body: body.to_json)
+        end
+        response_body =
+          begin
+            JSON.parse(result.body.to_s)
+          rescue JSON::ParserError
+            result.body
+          end
+        case result.code
+          when 200...226 then response_body
+          when 400 then fail People::BadRequest, response_body
+          when 401 then fail People::Unauthorized, response_body
+          when 403 then fail People::AccessDenied, response_body
+          when 404 then fail People::NotFound, response_body
+          when 500 then fail People::ServerError, response_body
+          else
+            fail People::Unsupported, response_body
+        end
+      end
+    end
+  end
+end

data/lib/people/initializer.rb

@@ -0,0 +1,40 @@
+require 'people/api/v1'
+
+module People
+  module Initializer
+    def initialize(config)
+      options = config.deep_symbolize_keys
+      self.class.base_uri base_url(options[:domain])
+      self.class.headers headers(options)
+      self.class.basic_auth *auth(options[:secret_key])
+    end
+
+    private
+
+    def auth(secret_key)
+      extend People::Api::V1
+      fail InvalidCredentials, 'Invalid API v1 secret_key' if secret_key.nil?
+      [secret_key, '']
+    end
+
+    def base_url(domain)
+      fail InvalidApiNamespace, 'Api namespace must supply an API domain' if domain.nil?
+      "#{domain}"
+    end
+
+    def headers(options)
+      headers = {}
+      client_info = JSON.dump(name: 'ruby-people', version: People::VERSION)
+
+      headers['Content-Type'] = 'application/json'
+
+      unless options[:opt_out_sdk_info]
+        headers['User-Agent'] = "Ruby/#{RUBY_VERSION}"
+        headers['People-Client'] = Base64.urlsafe_encode64(client_info)
+      end
+
+      headers
+    end
+
+  end
+end

data/lib/people/version.rb

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

data/people-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'people/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'people-ruby'
+  spec.version = People::VERSION
+  spec.authors = ['Raz Konforti']
+  spec.email = ['konforti@gmail.com']
+  spec.required_ruby_version = '>= 2.2.2'
+  spec.summary = 'Ruby bindings for People - Remote Identity Management People'
+  spec.description = 'The People Ruby bindings provide a small SDK for convenient access to the People API from applications written in the Ruby language.'
+  spec.homepage = 'https://github.com/konforti/people-ruby'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split("\n")
+  spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.13'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: people-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Raz Konforti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: The People Ruby bindings provide a small SDK for convenient access to
+  the People API from applications written in the Ruby language.
+email:
+- konforti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/people.rb
+- lib/people/api/v1.rb
+- lib/people/api/v1/persons.rb
+- lib/people/api/v1/roles.rb
+- lib/people/client.rb
+- lib/people/exception.rb
+- lib/people/http_proxy.rb
+- lib/people/initializer.rb
+- lib/people/version.rb
+- people-ruby.gemspec
+homepage: https://github.com/konforti/people-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: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for People - Remote Identity Management People
+test_files: []
+has_rdoc: