trogdir_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c84869f5c27f1d6ff0e6b6c542f0066bf0c41fd5
+  data.tar.gz: 5140f152412bf8030873d74c07b54408b318f18c
+SHA512:
+  metadata.gz: b3f7af1b5cb00fb77e0e9cf1f4a4a2b9efc8ee254248423357f17956c1c8d5a71da35fd39560fcbab9c76a0120499d6a538aacf27c1f22f3aa01b7dbf678a7a1
+  data.tar.gz: 6878a454c3674445e8fd68326bb78a8f1c70400312e6276fd376e0990472a6b267c960a5f9b98311e56eb94c4b2c839cc347f1df6971beacf0736da9fa23a756

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 by Biola University
+
+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,17 @@
+Trogdir API Client [![Build Status](https://travis-ci.org/biola/trogdir-api-client.svg?branch=master)](https://travis-ci.org/biola/trogdir-api-client)
+==================
+
+Installing
+----------
+
+Add `gem 'trogdir_api_client'` to your `Gemfile` and run `bundle`
+
+Usage
+-----
+
+TODO
+
+License
+-------
+
+MIT

data/lib/trogdir/api_client/addresses.rb

@@ -0,0 +1,23 @@
+module Trogdir
+  module APIClient
+    class Addresses < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      get :index, '/people/{uuid}/addresses'
+
+      get :show, '/people/{uuid}/addresses/{address_id}'
+
+      post :create, '/people/{uuid}/addresses' do |resource|
+        resource.required :type, :street_1
+        resource.optional :street_2, :city, :state, :zip, :country
+      end
+
+      put :update, '/people/{uuid}/addresses/{address_id}' do |resource|
+        resource.optional :type, :street_1, :street_2, :city, :state, :zip, :country
+      end
+
+      delete :destroy, '/people/{uuid}/addresses/{address_id}'
+    end
+  end
+end

data/lib/trogdir/api_client/change_syncs.rb

@@ -0,0 +1,19 @@
+module Trogdir
+  module APIClient
+    class ChangeSyncs < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      put :start, '/change_syncs/start'
+
+      put :error, '/change_syncs/error/{sync_log_id}' do |resource|
+        resource.required :message
+      end
+
+      put :finish, '/change_syncs/finish/{sync_log_id}' do |resource|
+        resource.required :action
+        resource.optional :message
+      end
+    end
+  end
+end

data/lib/trogdir/api_client/emails.rb

@@ -0,0 +1,23 @@
+module Trogdir
+  module APIClient
+    class Emails < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      get :index, '/people/{uuid}/emails'
+
+      get :show, '/people/{uuid}/emails/{email_id}'
+
+      post :create, '/people/{uuid}/emails' do |resource|
+        resource.required :type, :address
+        resource.optional :primary
+      end
+
+      put :update, '/people/{uuid}/emails/{email_id}' do |resource|
+        resource.optional :type, :address, :primary
+      end
+
+      delete :destroy, '/people/{uuid}/emails/{email_id}'
+    end
+  end
+end

data/lib/trogdir/api_client/ids.rb

@@ -0,0 +1,23 @@
+module Trogdir
+  module APIClient
+    class IDs < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      # use Weary::Middleware::ContentType
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      get :index, '/people/{uuid}/ids'
+
+      get :show, '/people/{uuid}/ids/{id_id}'
+
+      post :create, '/people/{uuid}/ids' do |resource|
+        resource.required :type, :identifier
+      end
+
+      put :update, '/people/{uuid}/ids/{id_id}' do |resource|
+        resource.optional :type, :identifier
+      end
+
+      delete :destroy, '/people/{uuid}/ids/{id_id}'
+    end
+  end
+end

data/lib/trogdir/api_client/people.rb

@@ -0,0 +1,52 @@
+module Trogdir
+  module APIClient
+    class People < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      # use Weary::Middleware::ContentType
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      get :index, '/people' do |resource|
+        resource.optional :affiliation
+      end
+
+      get :show, '/people/{uuid}'
+
+      get :by_id, '/people/by_id/{id}' do |resource|
+        resource.optional :type
+      end
+
+      post :create, '/people' do |resource|
+        resource.required :first_name, :last_name
+        resource.optional(
+          :preferred_name, :middle_name, :display_name, # Names
+          :gender, :partial_ssn, :birth_date,           # Demographic
+          :entitlements, :affiliations,                 # Groups and permissions
+
+          # STUDENT INFO #
+          :residence, :floor, :wing,  # On-Campus Residence
+          :majors,                    # Academic
+          :privacy,                   # FERPA
+
+          # EMPLOYEE INFO #
+          :department, :title, :employee_type, :full_time, :pay_type
+        )
+      end
+
+      put :update, '/people/{uuid}' do |resource|
+        resource.optional(
+          :first_name, :last_name, :preferred_name, :middle_name, :display_name,  # Names
+          :gender, :partial_ssn, :birth_date,                                     # Demographic
+          :entitlements, :affiliations,                                           # Groups and permissions
+
+          # STUDENT INFO #
+          :residence, :floor, :wing,  # On-Campus Residence
+          :majors,                    # Academic
+          :privacy,                   # FERPA
+
+          # EMPLOYEE INFO #
+          :department, :title, :employee_type, :full_time, :pay_type
+        )
+      end
+    end
+  end
+end

data/lib/trogdir/api_client/phones.rb

@@ -0,0 +1,23 @@
+module Trogdir
+  module APIClient
+    class Phones < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      get :index, '/people/{uuid}/phones'
+
+      get :show, '/people/{uuid}/phones/{phone_id}'
+
+      post :create, '/people/{uuid}/phones' do |resource|
+        resource.required :type, :number
+        resource.optional :primary
+      end
+
+      put :update, '/people/{uuid}/phones/{phone_id}' do |resource|
+        resource.optional :type, :number, :primary
+      end
+
+      delete :destroy, '/people/{uuid}/phones/{phone_id}'
+    end
+  end
+end

data/lib/trogdir/api_client/photos.rb

@@ -0,0 +1,22 @@
+module Trogdir
+  module APIClient
+    class Photos < Weary::Client
+      domain TrogdirAPIClient.config.base_url
+      use Weary::Middleware::HMACAuth, [TrogdirAPIClient.config.credentials]
+
+      get :index, '/people/{uuid}/photos'
+
+      get :show, '/people/{uuid}/photos/{photo_id}'
+
+      post :create, '/people/{uuid}/photos' do |resource|
+        resource.required :type, :url, :height, :width
+      end
+
+      put :update, '/people/{uuid}/photos/{photo_id}' do |resource|
+        resource.optional :type, :url, :width, :height
+      end
+
+      delete :destroy, '/people/{uuid}/photos/{photo_id}'
+    end
+  end
+end

data/lib/trogdir_api_client.rb

@@ -0,0 +1,31 @@
+require 'weary'
+
+module TrogdirAPIClient
+  require 'trogdir_api_client/configuration'
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end
+
+module Trogdir
+  module APIClient
+    autoload :People, 'trogdir/api_client/people'
+    autoload :IDs, 'trogdir/api_client/ids'
+    autoload :Emails, 'trogdir/api_client/emails'
+    autoload :Phones, 'trogdir/api_client/phones'
+    autoload :Photos, 'trogdir/api_client/photos'
+    autoload :Addresses, 'trogdir/api_client/addresses'
+    autoload :ChangeSyncs, 'trogdir/api_client/change_syncs'
+  end
+end
+
+module Weary
+  module Middleware
+    autoload :HMACAuth, 'weary/middleware/hmac_auth'
+  end
+end

data/lib/trogdir_api_client/configuration.rb

@@ -0,0 +1,34 @@
+require 'uri'
+
+module TrogdirAPIClient
+  class Configuration
+    attr_accessor :access_id
+    attr_accessor :secret_key
+
+    attr_accessor :scheme
+    attr_accessor :host
+    attr_accessor :script_name
+    attr_accessor :version
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.biola.edu'
+      @script_name = 'directory'
+      @version = 'v1'
+    end
+
+    def base_url
+      URI.join(root_url, "/#{script_name}/", version).to_s
+    end
+
+    def credentials
+      {access_id: access_id, secret_key: secret_key}
+    end
+
+    private
+
+    def root_url
+      URI::Generic.build(scheme: scheme, host: host)
+    end
+  end
+end

data/lib/trogdir_api_client/version.rb

@@ -0,0 +1,3 @@
+module TrogdirAPIClient
+  VERSION = '0.1.0'
+end

data/lib/weary/middleware/hmac_auth.rb

@@ -0,0 +1,58 @@
+require 'api_auth'
+
+module Weary
+  module Middleware
+    class HMACAuth
+
+      def initialize(app, config = {})
+        @app = app
+        @access_id = config[:access_id]
+        @secret_key = config[:secret_key]
+      end
+
+      def call(env)
+        set_content_type! env
+        sign! env
+        @app.call env
+      end
+
+      private
+
+      attr_reader :access_id, :secret_key
+
+      def set_content_type!(env)
+        env.tap do |e|
+          # Weary::Middleware::ContentType is dynamically injected after
+          # this middleware is called and since Content-Type is used to
+          # sign HMAC signatures, we have to mimic that behavior so that
+          # there's no difference in the headers when it's authenticated.
+          if ['POST', 'PUT'].include? e['REQUEST_METHOD']
+            e.update 'CONTENT_TYPE' => 'application/x-www-form-urlencoded'
+          end
+        end
+      end
+
+      def signed_request(env)
+        Rack::Request.new(env).tap do |r|
+          ApiAuth.sign! r, access_id, secret_key
+        end
+      end
+
+      def sign!(env)
+        req = signed_request(env)
+
+        env.tap do |e|
+          # Weary wants all headers to be in HTTP_[UPCASE] format for Rack env compatibility
+          e.update(
+            'HTTP_AUTHORIZATION' => req.env['Authorization'],
+            'HTTP_DATE' => req.env['DATE']
+          )
+
+          if md5 = req.env['Content-MD5']
+            e.update 'HTTP_CONTENT_MD5' => md5
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: trogdir_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Crownoble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: api-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: weary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: trogdir_api
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: API consuming models for the Trogdir directory project
+email: adam.crownoble@biola.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/trogdir/api_client/addresses.rb
+- lib/trogdir/api_client/change_syncs.rb
+- lib/trogdir/api_client/emails.rb
+- lib/trogdir/api_client/ids.rb
+- lib/trogdir/api_client/people.rb
+- lib/trogdir/api_client/phones.rb
+- lib/trogdir/api_client/photos.rb
+- lib/trogdir_api_client.rb
+- lib/trogdir_api_client/configuration.rb
+- lib/trogdir_api_client/version.rb
+- lib/weary/middleware/hmac_auth.rb
+homepage: https://github.com/biola/trogdir-api-client
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Client for the Trogdir directory API
+test_files: []