buweb_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2af5fcbeeb57b207ede3c883aeb56dd60e44a3e9
+  data.tar.gz: c251217e972003da03fb1621f2c2b1b0a2cba234
+SHA512:
+  metadata.gz: 28b34086f53040e91ebcac82895209103fa9a09b464ca34c72d4fc4d16ecbac7e9bd7c5a9b3567eac8235e7874a64a893b18685299ae7ff08b8f39665b81339b
+  data.tar.gz: 2c236feec572c2cf8d5e2a6df61183bd7871e7236391a8928dbbfde998a984d8c8eab49b552709f56ea6b47169fc13dfe8a6ec2f672145fb3a359b7f85dede6a

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 @@
+BU Web API Client [![Build Status](https://travis-ci.org/biola/buweb-api-client.svg?branch=master)](https://travis-ci.org/biola/buweb-api-client)
+==================
+
+Installing
+----------
+
+Add `gem 'buweb_api_client'` to your `Gemfile` and run `bundle`
+
+Usage
+-----
+
+TODO
+
+License
+-------
+
+MIT

data/lib/buweb/api_client/departments.rb

@@ -0,0 +1,14 @@
+module BUWeb
+  module APIClient
+    class Departments < Weary::Client
+      domain BUWebAPIClient.config.base_url
+      use Weary::Middleware::HMACAuth, [BUWebAPIClient.config.credentials]
+
+      get :index, '/departments/' do |resource|
+        resource.optional :location
+      end
+
+      get :show, '/departments/{id}'
+    end
+  end
+end

data/lib/buweb/api_client/people.rb

@@ -0,0 +1,17 @@
+module BUWeb
+  module APIClient
+    class People < Weary::Client
+      domain BUWebAPIClient.config.base_url
+      # use Weary::Middleware::ContentType
+      use Weary::Middleware::HMACAuth, [BUWebAPIClient.config.credentials]
+
+      get :index, '/people' do |resource|
+        resource.optional :affiliation
+      end
+
+      get :by_id, '/people/{id}' do |resource|
+        resource.optional :type
+      end
+    end
+  end
+end

data/lib/buweb_api_client/configuration.rb

@@ -0,0 +1,34 @@
+require 'uri'
+
+module BUWebAPIClient
+  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 = 'web'
+      @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/buweb_api_client/version.rb

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

data/lib/buweb_api_client.rb

@@ -0,0 +1,26 @@
+require 'weary'
+
+module BUWebAPIClient
+  require 'buweb_api_client/configuration'
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end
+
+module BUWeb
+  module APIClient
+    autoload :People, 'buweb/api_client/people'
+    autoload :Departments, 'buweb/api_client/departments'
+  end
+end
+
+module Weary
+  module Middleware
+    autoload :HMACAuth, 'weary/middleware/hmac_auth'
+  end
+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,177 @@
+--- !ruby/object:Gem::Specification
+name: buweb_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Devin Hanlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 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: biola_web_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: 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 Biola Web API project
+email: devin.hanlon@biola.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/buweb/api_client/departments.rb
+- lib/buweb/api_client/people.rb
+- lib/buweb_api_client.rb
+- lib/buweb_api_client/configuration.rb
+- lib/buweb_api_client/version.rb
+- lib/weary/middleware/hmac_auth.rb
+homepage: https://github.com/biola/buweb-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 Biola Web API
+test_files: []