brivo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0861fdd02d422aecc203d4185ac1c2de64973b57'
+  data.tar.gz: fe632e314d7a501ee286240243931a3c5cf1ddc2
+SHA512:
+  metadata.gz: b66f6d82df8429c0954379336be143f9a3a130a993c966a7b6a86da7800762e21b4606d12e1c4054038277b7d79fa1d3f690c22f90cdb7947cb964cdb46812b8
+  data.tar.gz: 6d5a835ec4c161666717cff3e398c16cd899151fdb21c0962317d4c163d4e423d0de82e92b46d01cff379737bdc9ad55ed7aec6f94517de9d730779ea3277d1c

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Techspace Property Group Ltd.
+
+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,77 @@
+# Brivo
+
+API wrapper for the [Brivo API](http://apidocs.brivo.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brivo'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install brivo
+```
+
+## Usage
+
+```ruby
+client = Brivo::Application.new(
+  client_id: YOUR_CLIENT_ID,
+  secret: YOUR_SECRET,
+  api_key: YOUR_API_KEY,
+  username: YOUR_USERNAME,
+  password: YOUR_PASSWORD
+)
+
+# Create a user
+client.user.create(
+  first_name: 'First name',
+  last_name: 'last name',
+  external_id: 1
+)
+
+# Get all users
+client.users
+
+# Find a user
+client.user(id)
+
+# Create a group
+client.group.create(
+  name: 'Group name'
+)
+
+# Get all groups
+client.groups
+
+# Find a group
+group = client.group(id)
+
+# Assign a user to a group
+group.assign_user(user_id)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/techspaceco/brivo
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brivo"
+
+# 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/brivo.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brivo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brivo"
+  spec.version       = Brivo::VERSION
+  spec.authors       = ["Adam Rainsby"]
+  spec.email         = ["adamrainsby@live.co.uk"]
+
+  spec.summary       = %q{Brivo API wrapper.}
+  spec.homepage      = "https://github.com/techspaceco/brivo"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "qq"
+end

data/lib/brivo.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'brivo/version'
+require 'brivo/error'
+require 'brivo/user'
+require 'brivo/group'
+require 'brivo/credential'
+require 'brivo/api/api'
+require 'brivo/collection'
+require 'brivo/application'

data/lib/brivo/api/api.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'brivo/api/http'
+require 'brivo/api/users'
+require 'brivo/api/groups'
+require 'brivo/api/credentials'

data/lib/brivo/api/credentials.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Brivo
+  module API
+    module Credentials
+      include Brivo::API::HTTP
+
+      FORMAT_NAME = 'Standard 26 Bit'
+
+      def credentials(status: nil)
+        path = 'credentials'
+        path += "?filter=status__eq:#{status}" if status
+        Brivo::Collection.new(self, path, credential_class)
+      end
+
+      def user_credentials(user_id)
+        Brivo::Collection.new(self, "users/#{user_id}/credentials", credential_class)
+      end
+
+      def credential id = nil
+        if id
+          credential_json = http_request("credentials/#{id}")
+          credential_class.new(credential_json)
+        else
+          credential_class
+        end
+      end
+
+      def create_credential id, facility_code
+        @credential_formats ||= http_request('credentials/formats')['data']
+        credential_format = @credential_formats.find do |format|
+          format['name'] == FORMAT_NAME
+        end
+
+        credential_json = http_request(
+          'credentials',
+          params: {
+            credentialFormat: {
+              id: credential_format['id']
+            },
+            referenceId: id,
+            fieldValues: [
+              {id: 1, value: id},
+              {id: 2, value: facility_code}
+            ]
+          },
+          method: :post
+        )
+
+        credential_class.new(credential_json)
+      end
+
+      def delete_credential id
+        http_request "credentials/#{id}", method: :delete
+      end
+
+      private
+
+      def credential_class
+        Brivo::Credential.tap { |klass| klass.application = self }
+      end
+    end
+  end
+end

data/lib/brivo/api/groups.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Brivo
+  module API
+    module Groups
+      include Brivo::API::HTTP
+
+      def groups
+        Brivo::Collection.new(self, 'groups', group_class)
+      end
+
+      def user_groups(user_id)
+        Brivo::Collection.new(self, "users/#{user_id}/groups", group_class)
+      end
+
+      def group id = nil
+        if id
+          group_json = http_request("groups/#{id}")
+          group_class.new(group_json)
+        else
+          group_class
+        end
+      end
+
+      def group_assign_user group_id, user_id
+        http_request "groups/#{group_id}/users/#{user_id}", method: :put
+      end
+
+      def group_remove_user group_id, user_id
+        http_request "groups/#{group_id}/users/#{user_id}", method: :delete
+      end
+
+      def create_group name
+        group_json = http_request(
+          'groups',
+          params: {
+            name: name
+          },
+          method: :post
+        )
+
+        group_class.new(group_json)
+      end
+
+      def delete_group id
+        http_request "groups/#{id}", method: :delete
+      end
+
+      private
+
+      def group_class
+        Brivo::Group.tap { |klass| klass.application = self }
+      end
+    end
+  end
+end

data/lib/brivo/api/http.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Brivo
+  module API
+    module HTTP
+      MAX_RETRIES = 3
+      API_URL = -'https://api.brivo.com/v1/api'
+      PAGE_SIZE = 100
+      DEFAULT_HTTPS_SETTINGS = {
+        use_ssl: true,
+        open_timeout: 3,
+        read_timeout: 3,
+        ssl_timeout: 3
+      }
+
+      def set_access_token
+        uri = URI.parse("https://auth.brivo.com/oauth/token?grant_type=password&username=#{username}&password=#{password}")
+
+        authorization_code = Base64.strict_encode64("#{client_id}:#{secret}")
+
+        res = Net::HTTP.start(uri.host, uri.port, DEFAULT_HTTPS_SETTINGS) do |https|
+          req = Net::HTTP::Post.new(uri)
+          req['Content-Type'] = 'application/json'
+          req['Authorization'] = "Basic #{authorization_code}"
+          req['api-key'] = api_key
+
+          https.request(req)
+        end
+
+        response = JSON.parse res.body
+
+        @access_token = response['access_token']
+        @access_token_expiry = monotonic_time + (response['expires_in'] - 2)
+      end
+
+      def http_request path, method: :get, params: {}, offset: nil
+        attempts = 0
+        begin
+          attempts += 1
+          uri = "#{API_URL}/#{path}"
+
+          parsed_uri = URI.parse(uri)
+
+          if offset
+            if parsed_uri.query.nil?
+              parsed_uri.query = "pageSize=#{PAGE_SIZE}&offset=#{offset}"
+            else
+              parsed_uri.query = "#{parsed_uri.query}&pageSize=#{PAGE_SIZE}&offset=#{offset}"
+            end
+          end
+
+          http_methods = {
+            get: Net::HTTP::Get,
+            post: Net::HTTP::Post,
+            put: Net::HTTP::Put,
+            delete: Net::HTTP::Delete
+          }
+
+          response = Net::HTTP.start(parsed_uri.host, parsed_uri.port, DEFAULT_HTTPS_SETTINGS) do |https|
+            request = http_methods[method].new(parsed_uri)
+            request.body = params.to_json
+
+            if @access_token.nil? || monotonic_time > @access_token_expiry
+              set_access_token
+            end
+
+            request['Content-Type'] = 'application/json'
+            request['Authorization'] = "bearer #{@access_token}"
+            request['api-key'] = api_key
+
+            https.request(request)
+          end
+
+          # http://apidocs.brivo.com/#response-codes
+          case response.code.to_i
+          when 200
+            JSON.parse(response.body)
+          when 201
+            JSON.parse(response.body)
+          when 204
+            true
+          when 400
+            raise Brivo::Error::BadRequest
+          when 401
+            raise Brivo::Error::Unauthorized
+          when 403
+            raise Brivo::Error::Forbidden
+          when 404
+            raise Brivo::Error::NotFound
+          when 415
+            raise Brivo::Error::UnsupportedMediaType
+          when 418
+            raise Brivo::Error::IsATeapot
+          when 503
+            raise Brivo::Error::ServiceUnavailable
+          when 596
+            raise Brivo::Error::ServiceNotFound
+          else
+            raise Brivo::Error::UnkownResponse
+          end
+        rescue StandardError
+          if attempts > MAX_RETRIES
+            raise
+          else
+            retry
+          end
+        end
+      end
+
+      private
+
+      def monotonic_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/brivo/api/users.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Brivo
+  module API
+    module Users
+      include Brivo::API::HTTP
+
+      def users
+        Brivo::Collection.new(self, 'users', user_class)
+      end
+
+      def group_users group_id
+        Brivo::Collection.new(self, "groups/#{group_id}/users", user_class)
+      end
+
+      def credential_user credential_id
+        user_json = http_request("credentials/#{credential_id}/user")
+        user_class.new(user_json)
+      end
+
+      def user id = nil, external_id: nil
+        if id
+          user_json = http_request "users/#{id}"
+          user_class.new(user_json)
+        elsif external_id
+          user_json = http_request "users/#{external_id}/external"
+          user_class.new(user_json)
+        else
+          user_class
+        end
+      end
+
+      def create_user first_name, last_name, external_id, suspended = false
+        user_json = http_request(
+          'users',
+          params: {
+            firstName: first_name,
+            lastName: last_name,
+            externalId: external_id,
+            suspended: suspended
+          },
+          method: :post
+        )
+
+        user_class.new(user_json)
+      end
+
+      def delete_user id
+        http_request "users/#{id}", method: :delete
+      end
+
+      def user_assign_credential user_id, credential_id, effective_from, effective_to
+        http_request(
+          "users/#{user_id}/credentials/#{credential_id}",
+          method: :put,
+          params: {
+            effectiveFrom: effective_from,
+            effectiveTo: effective_to
+          }
+        )
+      end
+
+      def user_remove_credential user_id, credential_id
+        http_request "users/#{user_id}/credentials/#{credential_id}", method: :delete
+      end
+
+      private
+
+      def user_class
+        Brivo::User.tap { |klass| klass.application = self }
+      end
+    end
+  end
+end

data/lib/brivo/application.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Brivo
+  class Application
+    include Brivo::API::Users
+    include Brivo::API::Groups
+    include Brivo::API::Credentials
+
+    attr_reader :client_id, :secret, :api_key, :username, :password
+
+    def initialize client_id:, secret:, api_key:, username:, password:
+      @client_id = client_id
+      @secret = secret
+      @api_key = api_key
+      @username = username
+      @password = password
+    end
+  end
+end

data/lib/brivo/collection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Brivo
+  class Collection
+    include Enumerable
+
+    def initialize application, api_path, model
+      @application = application
+      @api_path = api_path
+      @model = model
+      @collection = []
+
+      fetch_collection
+    end
+
+
+    def each(&block)
+      total_count = @total_count
+      while @collection.count < total_count do
+        collection_count = @collection.count
+        fetch_collection(offset: collection_count)
+      end
+
+      @collection.each(&block)
+    end
+
+    private
+
+    def fetch_collection offset: 0
+      response = @application.http_request(@api_path, offset: offset)
+      @total_count = response['count']
+      response['data'].each do |json|
+        @collection << @model.new(json)
+      end
+    end
+  end
+end

data/lib/brivo/credential.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Brivo
+  class Credential
+    attr_reader :id, :reference_id, :field_values
+
+    class << self
+      attr_accessor :application
+
+      def create id:, facility_code:
+        application.create_credential(id, facility_code)
+      end
+    end
+
+    def initialize attributes = {}
+      @id = attributes['id']
+      @reference_id = attributes['referenceId']
+      @field_values = attributes['fieldValues']&.map do |field_value|
+        field_value.inject({}) do |m, (k, v)|
+          m.tap { m[k.to_sym] = v }
+        end
+      end
+    end
+
+    def delete
+      application.delete_credential(id)
+    end
+
+    def user
+      application.credential_user(id)
+    end
+
+    private
+
+    def application
+      self.class.application
+    end
+  end
+end

data/lib/brivo/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Brivo
+  class Error < StandardError
+    class BadRequest < Error; end
+    class Unauthorized < Error; end
+    class Forbidden < Error; end
+    class NotFound < Error; end
+    class UnsupportedMediaType < Error; end
+    class ServiceUnavailable < Error; end
+    class ServiceNotFound < Error; end
+    class UnkownResponse < Error; end
+    class IsATeapot < Error; end
+  end
+end

data/lib/brivo/group.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Brivo
+  class Group
+    attr_reader :id, :name
+    class << self
+      attr_accessor :application
+
+      def create name:
+        application.create_group(name)
+      end
+    end
+
+    def initialize attributes = {}
+      @id = attributes['id']
+      @name = attributes['name']
+    end
+
+    def delete
+      application.delete_group(id)
+    end
+
+    def users
+      application.group_users(id)
+    end
+
+    def assign_user user_id
+      application.group_assign_user(id, user_id)
+    end
+
+    def remove_user user_id
+      application.group_remove_user(id, user_id)
+    end
+
+    private
+
+    def application
+      self.class.application
+    end
+  end
+end

data/lib/brivo/user.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Brivo
+  class User
+    attr_reader :id, :first_name, :last_name, :external_id, :suspended
+    class << self
+      attr_accessor :application
+
+      def create first_name:, last_name:, external_id: nil, suspended: false
+        application.create_user(first_name, last_name, external_id, suspended)
+      end
+    end
+
+    def initialize attributes = {}
+      @id = attributes['id']
+      @first_name = attributes['firstName']
+      @last_name = attributes['lastName']
+      @external_id = attributes['externalId']
+      @suspended = attributes['suspended']
+    end
+
+    def delete
+      application.delete_user(id)
+    end
+
+    def groups
+      application.user_groups(id)
+    end
+
+    def credentials
+      application.user_credentials(id)
+    end
+
+    def assign_credential credential_id, effective_from, effective_to
+      application.user_assign_credential(id, credential_id, effective_from, effective_to)
+    end
+
+    def remove_credential credential_id
+      application.user_remove_credential(id, credential_id)
+    end
+
+    private
+
+    def application
+      self.class.application
+    end
+  end
+end

data/lib/brivo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Brivo
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: brivo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Rainsby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: qq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- adamrainsby@live.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brivo.gemspec
+- lib/brivo.rb
+- lib/brivo/api/api.rb
+- lib/brivo/api/credentials.rb
+- lib/brivo/api/groups.rb
+- lib/brivo/api/http.rb
+- lib/brivo/api/users.rb
+- lib/brivo/application.rb
+- lib/brivo/collection.rb
+- lib/brivo/credential.rb
+- lib/brivo/error.rb
+- lib/brivo/group.rb
+- lib/brivo/user.rb
+- lib/brivo/version.rb
+homepage: https://github.com/techspaceco/brivo
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Brivo API wrapper.
+test_files: []