omniauth-camdram 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec242a381b498fe1b3ab75f5cd57ee545cb19f7038089b973b372725836df780
+  data.tar.gz: 67772bf15435739ff38629ada6d957af330b300d2ceb9ad0ba16ee753aca595b
+SHA512:
+  metadata.gz: d9a0dcb837780f006a6fb89d5f9ed3c0644f8cff18e4dc88eb34f5098d4413d2293bd2b01e1589112645e4c4d31c05a5c01a2e91c1e14b308f4705983409f594
+  data.tar.gz: 3643f046493761658d01d9a0c70f5a3de4900ba7d1defe546d17893bee9bc5ef3cf3578117e19f61a75fc8c9e73932c296c90bca2fd17819216472146dd20a31

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Charlie Jonas
+
+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,43 @@
+# Camdram's Omniauth strategy
+
+This is the official Ruby OmniAuth strategy for authenticating to [Camdram](https://www.camdram.net).
+
+Before you can start developing your API client for Camdram, you need to [create an application](https://www.camdram.net/api/apps/new) and copy the application ID and secret key.
+
+## Installation
+
+Add the strategy to your `Gemfile`:
+
+```ruby
+gem 'omniauth-camdram'
+```
+
+And then run `bundle install`.
+
+## Usage
+
+You can integrate the strategy into your middleware in a `config.ru`:
+
+```ruby
+use OmniAuth::Builder do
+  provider :camdram, SETTINGS['CAMDRAM_APP_ID'], SETTINGS['CAMDRAM_APP_SECRET'], scope: "user_shows user_orgs user_email write write_org"
+end
+```
+
+If you're using Rails, you'll want to add to the middleware stack:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :camdram, SETTINGS['CAMDRAM_APP_ID'], SETTINGS['CAMDRAM_APP_SECRET'], scope: "user_shows user_orgs user_email write write_org"
+end
+```
+
+You can see a description of the different types of scope on the [Camdram repository](https://github.com/camdram/camdram/blob/master/src/Acts/CamdramApiBundle/Resources/views/Authorize/authorize.html.twig).
+
+For additional information, please refer to the [OmniAuth wiki](https://github.com/intridea/omniauth/wiki).
+
+See the [example](https://github.com/camdram/omniauth-camdram/blob/master/examples/sinatra/config.ru) Sinatra app for full examples.
+
+## License
+
+omniauth-camdram is released under the MIT License.

data/examples/sinatra/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'omniauth'
+gem 'omniauth-camdram', :path => '../../'
+gem 'multi_json'

data/examples/sinatra/README.md

@@ -0,0 +1,12 @@
+# Sinatra Example
+
+This example clearly demonstrates how to use the omniauth-camdram strategy with a simple Sinatra web app.
+You will need to create a new API app at https://www.camdram.net/api/apps before you continue.
+
+## Setup
+
+1. `git clone https://github.com/camdram/omniauth-camdram.git`
+2. `cd omniauth-camdram/examples/sinatra`
+3. Set the ENV variables CAMDRAM_APP_ID and CAMDRAM_APP_SECRET
+4. Run the `rackup` command
+5. Navigate to http://localhost:4567 and complete the login process

data/examples/sinatra/config.ru

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sinatra'
+require 'omniauth-camdram'
+
+class CamdramExample < Sinatra::Base
+  use Rack::Session::Cookie
+
+  get '/' do
+    redirect '/auth/camdram'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+
+  get '/auth/failure' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+
+  use OmniAuth::Builder do
+    provider OmniAuth::Strategies::Camdram, ENV["CAMDRAM_APP_ID"], ENV["CAMDRAM_APP_SECRET"], scope: "user_shows user_orgs"
+  end
+end
+
+run CamdramExample.run!

data/lib/omniauth-camdram.rb

@@ -0,0 +1,2 @@
+require "omniauth-camdram/version"
+require "omniauth/strategies/camdram"

data/lib/omniauth-camdram/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Camdram
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/camdram.rb

@@ -0,0 +1,47 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    #
+    # Authenticate to Camdram via OAuth and retrieve basic user information.
+    # Usage:
+    #    use OmniAuth::Strategies::Camdram, 'app-id-key', 'app-secret-key', :scope => 'user_shows user_orgs', :display => 'plain'
+    #
+    class Camdram < OmniAuth::Strategies::OAuth2
+      BASE_URL = "https://www.camdram.net"
+
+      option :name, "camdram"
+
+      unless OmniAuth.config.test_mode
+        option :client_options, {
+          :authorize_url => "#{BASE_URL}/oauth/v2/auth",
+          :token_url => "#{BASE_URL}/oauth/v2/token",
+          :site => BASE_URL
+        }
+      else
+        option :client_options, {
+          :authorize_url => "http://localhost:3000/oauth/v2/auth",
+          :token_url => "http://localhost:3000/oauth/v2/token",
+          :site => "http://localhost:3000"
+        }
+      end
+
+      uid do
+        raw_info['id']
+      end
+
+      info do
+        {
+          :name => raw_info['name'],
+          :email => raw_info['email'],
+          :type => raw_info['_type']
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/auth/account.json').parsed
+      end
+
+    end
+  end
+end

data/omniauth-camdram.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-camdram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-camdram"
+  spec.version       = Omniauth::Camdram::VERSION
+  spec.authors       = ["Charlie Jonas"]
+  spec.email         = ["devel@charliejonas.co.uk"]
+  spec.summary       = %q{Official OmniAuth strategy for Camdram}
+  spec.description   = %q{Official OmniAuth strategy for Camdram}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth", "~> 1.0"
+  spec.add_dependency "omniauth-oauth2", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.7"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-camdram
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charlie Jonas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: omniauth-oauth2
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: simplecov
+  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'
+description: Official OmniAuth strategy for Camdram
+email:
+- devel@charliejonas.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- examples/sinatra/Gemfile
+- examples/sinatra/README.md
+- examples/sinatra/config.ru
+- lib/omniauth-camdram.rb
+- lib/omniauth-camdram/version.rb
+- lib/omniauth/strategies/camdram.rb
+- omniauth-camdram.gemspec
+homepage: ''
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Camdram
+test_files: []