google_syncinator_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6746ed6b42fa2c0bcc67fd6d132e6c13e60a0c5
+  data.tar.gz: 17340e693ea0bb4367d6e22fa19d4e46552d3db5
+SHA512:
+  metadata.gz: 87eef4b73e1d7090e808c3249a9f2854e160ea3cf35d4e497942e836f3b0b90ed0b6b063abf5b324715fdba91aebdeef6e1e6f24bcdff4012626a1d8ebd6ef8f
+  data.tar.gz: 606b106580f8de0c283d53f6f156c80894428b1ba73678d2417a7549b7b10b996818d0eac0b1911131376bce69c124595b3b2bc878fe72c2a783fe0e84abf80d

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 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,66 @@
+GoogleSyncinator API Client [![Build Status](https://travis-ci.org/biola/google-syncinator-api-client.svg?branch=master)](https://travis-ci.org/biola/google-syncinator-api-client)
+==================
+
+Google Syncinator API Client is a client to the [google-syncinator](https://github.com/biola/google-syncinator) API (duh!)
+
+Installing
+----------
+
+Add `gem 'google_syncinator_api_client'` to your `Gemfile` and run `bundle`
+
+Configuration
+-------------
+
+```ruby
+GoogleSyncinatorAPIClient.configure do |config|
+  # Optional:
+  # config.scheme = 'http'
+  # config.host = 'localhost'
+  # config.script_name = nil
+  # config.version = 'v1'
+
+  # Required:
+  config.access_id = '**************'
+  config.secret_key = '*****************************************'
+end
+```
+
+Getting Credentials
+-------------------
+
+To create a google-syncinator client and get an `access_id` and `secret_key`, see the [google-syncinator README](https://github.com/biola/google-syncinator/blob/master/README.md).
+
+Usage
+-----
+
+### Example Syncinator
+
+```ruby
+require 'google_syncinator_api_client'
+require 'multi_json'
+
+emails_api = GoogleSyncinator::APIClient::Emails.new
+emails = emails_api.index.perform.parse
+emails_api.show(id: emails.first['id']).perform.parse
+
+person_emails_api = GoogleSyncinator::APIClient::PersonEmails.new
+person_email = person_emails_api.create(uuid: 'TROGDIR_PERSON_UUID', address: 'test@example.com').perform.parse
+person_emails_api.show(id: person_email['id']).perform
+
+alias_emails_api = GoogleSyncinator::APIClient::AliasEmails.new
+alias_email = alias_emails_api.create(account_email_id: person_email['id'], address: 'test@example.com').perform.parse
+alias_emails_api.show(id: alias_email['id']).perform
+
+deprovision_schedules_api = GoogleSyncinator::APIClient::DeprovisionSchedules.new
+deprovision_schedule = deprovision_schedules_api.create(email_id: person_email['id'], action: :suspend, scheduled_for: Time.now).perform.parse
+deprovision_schedules_api.update(email_id: person_email['id'], id: deprovision_schedule['id'], canceled: true).perform
+deprovision_schedules_api.destroy(email_id: person_email['id'], id: deprovision_schedule['id']).perform
+
+exclusions_api = GoogleSyncinator::APIClient::Exclusions.new
+exclusion_api = exclusions_api.create(email_id: person_email['id'], creator_uuid: 'TROGDIR_PERSON_UUID', starts_at: Time.now).perform.parse
+exclusions_api.destroy(email_id: person_email['id'], id: exclusion_api['id']).perform
+```
+
+License
+-------
+[MIT](https://github.com/biola/google-syncinator-api-client/blob/master/MIT-LICENSE)

data/lib/google_syncinator/api_client/account_emails.rb

@@ -0,0 +1,13 @@
+module GoogleSyncinator
+  module APIClient
+    class AccountEmails < Weary::Client
+      include Settings
+
+      get :search, '/account_emails' do |resource|
+        resource.required :q
+      end
+
+      get :show, '/account_emails/{id}'
+    end
+  end
+end

data/lib/google_syncinator/api_client/alias_emails.rb

@@ -0,0 +1,13 @@
+module GoogleSyncinator
+  module APIClient
+    class AliasEmails < Weary::Client
+      include Settings
+
+      get :show, '/alias_emails/{id}'
+
+      post :create, '/alias_emails' do |resource|
+        resource.required :account_email_id, :address
+      end
+    end
+  end
+end

data/lib/google_syncinator/api_client/department_emails.rb

@@ -0,0 +1,18 @@
+module GoogleSyncinator
+  module APIClient
+    class DepartmentEmails < Weary::Client
+      include Settings
+
+      get :show, '/department_emails/{id}'
+
+      post :create, '/department_emails' do |resource|
+        resource.required :address, :uuids, :first_name, :last_name
+        resource.optional :password, :department, :title, :privacy
+      end
+
+      put :update, '/department_emails/{id}' do |resource|
+        resource.optional :address, :uuids, :password, :first_name, :last_name, :department, :title, :privacy
+      end
+    end
+  end
+end

data/lib/google_syncinator/api_client/deprovision_schedules.rb

@@ -0,0 +1,20 @@
+module GoogleSyncinator
+  module APIClient
+    class DeprovisionSchedules < Weary::Client
+      include Settings
+
+      post :create, '/emails/{email_id}/deprovision_schedules' do |resource|
+        resource.required :action, :scheduled_for
+        resource.optional :reason
+      end
+
+      put :update, '/emails/{email_id}/deprovision_schedules/{id}' do |resource|
+        # There shouldn't be any reason to update a deprovision schedule other
+        #   than to cancel it
+        resource.required :canceled
+      end
+
+      delete :destroy, '/emails/{email_id}/deprovision_schedules/{id}'
+    end
+  end
+end

data/lib/google_syncinator/api_client/emails.rb

@@ -0,0 +1,13 @@
+module GoogleSyncinator
+  module APIClient
+    class Emails < Weary::Client
+      include Settings
+
+      get :index, '/emails' do |resource|
+        resource.optional :q, :state, :pending, :page, :per_page, :offset
+      end
+
+      get :show, '/emails/{id}'
+    end
+  end
+end

data/lib/google_syncinator/api_client/exclusions.rb

@@ -0,0 +1,14 @@
+module GoogleSyncinator
+  module APIClient
+    class Exclusions < Weary::Client
+      include Settings
+
+      post :create, '/emails/{email_id}/exclusions' do |resource|
+        resource.required :creator_uuid, :starts_at
+        resource.optional :ends_at, :reason
+      end
+
+      delete :destroy, '/emails/{email_id}/exclusions/{id}'
+    end
+  end
+end

data/lib/google_syncinator/api_client/person_emails.rb

@@ -0,0 +1,17 @@
+module GoogleSyncinator
+  module APIClient
+    class PersonEmails < Weary::Client
+      include Settings
+
+      get :show, '/person_emails/{id}'
+
+      post :create, '/person_emails' do |resource|
+        resource.required :uuid, :address
+      end
+
+      put :update, '/person_emails/{id}' do |resource|
+        resource.required :address
+      end
+    end
+  end
+end

data/lib/google_syncinator/api_client/settings.rb

@@ -0,0 +1,11 @@
+module GoogleSyncinator
+  module APIClient
+    module Settings
+      def self.included(base)
+        base.send :domain, GoogleSyncinatorAPIClient.config.base_url
+        base.send :adapter, Weary::Adapter::NetHttpAdvanced
+        base.send :use, Weary::Middleware::HMACAuth, [GoogleSyncinatorAPIClient.config.credentials]
+      end
+    end
+  end
+end

data/lib/google_syncinator_api_client.rb

@@ -0,0 +1,36 @@
+require 'weary'
+
+module GoogleSyncinatorAPIClient
+  require 'google_syncinator_api_client/configuration'
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end
+
+module GoogleSyncinator
+  module APIClient
+    autoload :Settings, 'google_syncinator/api_client/settings'
+    autoload :DeprovisionSchedules, 'google_syncinator/api_client/deprovision_schedules'
+    autoload :AccountEmails, 'google_syncinator/api_client/account_emails'
+    autoload :AliasEmails, 'google_syncinator/api_client/alias_emails'
+    autoload :Emails, 'google_syncinator/api_client/emails'
+    autoload :PersonEmails, 'google_syncinator/api_client/person_emails'
+    autoload :DepartmentEmails, 'google_syncinator/api_client/department_emails'
+    autoload :Exclusions, 'google_syncinator/api_client/exclusions'
+  end
+end
+
+module Weary
+  module Middleware
+    autoload :HMACAuth, 'weary/middleware/hmac_auth'
+  end
+
+  module Adapter
+    autoload :NetHttpAdvanced, 'weary/adapters/net_http_advanced'
+  end
+end

data/lib/google_syncinator_api_client/configuration.rb

@@ -0,0 +1,36 @@
+require 'uri'
+
+module GoogleSyncinatorAPIClient
+  class Configuration
+    attr_accessor :access_id
+    attr_accessor :secret_key
+
+    attr_accessor :scheme
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :script_name
+    attr_accessor :version
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.biola.edu'
+      @port = nil
+      @script_name = 'google-syncinator'
+      @version = 'v1'
+    end
+
+    def base_url
+      URI.join(root_url.to_s, "/#{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, port: port)
+    end
+  end
+end

data/lib/google_syncinator_api_client/version.rb

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

data/lib/weary/adapters/net_http_advanced.rb

@@ -0,0 +1,16 @@
+module Weary
+  module Adapter
+    class NetHttpAdvanced < NetHttp
+      class << self
+        attr_accessor :timeout
+      end
+
+      def self.connect(request)
+        connection = socket(request)
+        connection.read_timeout = timeout unless timeout.nil?
+        response = connection.request prepare(request)
+        Rack::Response.new response.body || "", response.code, normalize_response(response.to_hash)
+      end
+    end
+  end
+end

data/lib/weary/middleware/hmac_auth.rb

@@ -0,0 +1,60 @@
+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'
+          elsif e['REQUEST_METHOD'] == 'GET' && e['CONTENT_TYPE'].to_s == ''
+            e.update 'CONTENT_TYPE' => 'text/plain'
+          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,171 @@
+--- !ruby/object:Gem::Specification
+name: google_syncinator_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Biola University
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-21 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: 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 GoogleSyncinator project
+email: appsupport@biola.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/google_syncinator/api_client/account_emails.rb
+- lib/google_syncinator/api_client/alias_emails.rb
+- lib/google_syncinator/api_client/department_emails.rb
+- lib/google_syncinator/api_client/deprovision_schedules.rb
+- lib/google_syncinator/api_client/emails.rb
+- lib/google_syncinator/api_client/exclusions.rb
+- lib/google_syncinator/api_client/person_emails.rb
+- lib/google_syncinator/api_client/settings.rb
+- lib/google_syncinator_api_client.rb
+- lib/google_syncinator_api_client/configuration.rb
+- lib/google_syncinator_api_client/version.rb
+- lib/weary/adapters/net_http_advanced.rb
+- lib/weary/middleware/hmac_auth.rb
+homepage: https://github.com/biola/google-syncinator-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 GoogleSyncinator API
+test_files: []
+has_rdoc: