omniauth-napster 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ff9dfeb32f08ffae0527df43cb36aeda85002c2
-  data.tar.gz: c37b463680191b510f2c2920d0f086ddb04225e7
+  metadata.gz: eb41ca84885aa059bf5e4d142ba7562d75d7a31a
+  data.tar.gz: e3777f41739b129e8aac19e835e660725aea06d3
 SHA512:
-  metadata.gz: 803ff842a2a06e1f10987e47bee024b68edc2d187de0e486c50c127a766a3e0fca00294564ad3afd87e90da45b021fc7a73c5c4f54b7b590850d6d9d955756ca
-  data.tar.gz: 2246d6ca5cd0aa504e97b4072faf2885625ceef877985be036d18888a04c8d0b76f96a86a09b298f574786fac27616e0bcd3634790d49fd24f606c555da2990f
+  metadata.gz: 5a1095637477513335d4e5381b7c22e7e00af3ae90c9e1b080cd0b29cb38ece1b6254003d5c0dfa1059d2e63ad7e8f9ea9ecfc6645cb5c1af5a8217e92482ed0
+  data.tar.gz: abfd0e41190f8ab63d41cadc2e81ce2e8c7faec2adc05a2bd2219abf20968adb0bd36ab5b488e02c595c98a901a06d901149284f9885ab7ea5f455e4bb699ea1

data/.gitignore

@@ -1,9 +1,4 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+*.gem
+.bundle
+.config
+Gemfile.lock

data/Gemfile

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

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Jason Kim
+Copyright (c) 2016 Rhapsody International
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,41 +1,100 @@
-# Omniauth::Napster
+<!--
+[![Gem Version](https://badge.fury.io/rb/omniauth-napster.svg)](https://badge.fury.io/rb/omniauth-napster)
+-->
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/napster`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Napster Music OmniAuth Strategy
 
-TODO: Delete this and the text above, and describe your gem
+This gem provides the [OmniAuth](https://github.com/intridea/omniauth) strategy for the [Napster API](https://developer.napster.com).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'omniauth-napster'
-```
+```$ gem 'omniauth-napster'```
 
 And then execute:
 
-    $ bundle
+```$ bundle```
 
 Or install it yourself as:
 
-    $ gem install omniauth-napster
+```$ gem install omniauth-napster```
 
 ## Usage
 
-TODO: Write usage instructions here
+You'll need to register your app with Napster.  Visit https://developer.napster.com/developer/apps/new to get started.
 
-## Development
+Using this gem is similar to other OmniAuth strategies.  Add your app credentials to `config/initializers/omniauth.rb`:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :napster, ENV['NAPSTER_API_KEY'], ENV['NAPSTER_API_SECRET']
+end
+```
 
-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).
+Or with Devise in `config/initializers/devise.rb`:
 
-## Contributing
+```ruby
+config.omniauth :napster, ENV['NAPSTER_API_KEY'], ENV['NAPSTER_API_SECRET']
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-napster.
+## Auth Hash Schema
 
+Here's an example auth hash, available in `request.env['omniauth.auth']`:
+```
+{
+  "provider":"napster",
+  "uid":"295DC739BEDA4BB8E050960A380358BC",
+  "info": {
+    "uid":"295DC739BEDA4BB8E050960A380358BC",
+    "name":"Testy Testerson",
+    "username":"NAPIcat",
+    "image":"http://direct.rhapsody.com/imageserver/v2/external/aHR0cHM6Ly9yaGFwc29keS1uYXBpLnMzLmFtYXpvbmF3cy5jb20vbWVtYmVyLzI5NURDNzM5QkVEQTRCQjhFMDUwOTYwQTM4MDM1OEJDL2F2YXRhci9vcmlnaW5hbA%3D%3D/images/108x108.jpg"
+  },
+  "credentials": {
+    "token":"NTQ3NjI5NDktNWIyZC00MDVlLTg2MDMtZDhhMGQ2YTYzMTk3",
+    "refresh_token":"0b4bdad8-1c82-44d0-8cdb-dd8d2b6e6331",
+    "expires_at":1463103543,
+    "expires":true
+  },
+  "extra": {
+    "raw_info": {
+      "me": {
+        "id": "295DC739BEDA4BB8E050960A380358BC",
+        "realName": "Testy Testerson",
+        "screenName": "NAPIcat",
+        "bio": "The cat is back!",
+        "location":"Seattle, WA",
+        "visibility": "public",
+        "type": "member",
+        "href": "http://api.rhapsody.com/members/295DC739BEDA4BB8E050960A380358BC",
+        "favoriteAlbumsCount": 0,
+        "favoriteArtistsCount": 0,
+        "favoriteTracksCount": 0,
+        "playlistsTotalCount": 0,
+        "playlistsPublishedCount": 0,
+        "stationsCount": 0,
+        "radioCount": 0,
+        "followingCount": 2,
+        "followerCount": 10,
+        "avatar": "http://direct.rhapsody.com/imageserver/v2/external/aHR0cHM6Ly9yaGFwc29keS1uYXBpLnMzLmFtYXpvbmF3cy5jb20vbWVtYmVyLzI5NURDNzM5QkVEQTRCQjhFMDUwOTYwQTM4MDM1OEJDL2F2YXRhci9vcmlnaW5hbA%3D%3D/images/108x108.jpg",
+        "avatarId": "aHR0cHM6Ly9yaGFwc29keS1uYXBpLnMzLmFtYXpvbmF3cy5jb20vbWVtYmVyLzI5NURDNzM5QkVEQTRCQjhFMDUwOTYwQTM4MDM1OEJDL2F2YXRhci9vcmlnaW5hbA%3D%3D",
+        "defaultAvatar": "false",
+        "avatarVersion": 1465508896140
+      }
+    }
+  }
+}
+```
 
-## License
+## More
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+This gem is brought to you by the NAPI (Napster API) development team.  Please [reach out to us](https://groups.google.com/forum/#!forum/rhapsody-api) if you have any questions.
+
+## Contributing
 
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,6 +1 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/lib/omniauth-napster.rb

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

data/lib/omniauth/napster.rb

@@ -1,7 +1,5 @@
-require "omniauth/napster/version"
-
-module Omniauth
+module OmniAuth
   module Napster
-    # Your code goes here...
+    VERSION = "0.1.0"
   end
 end

data/lib/omniauth/strategies/napster.rb

@@ -0,0 +1,36 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Napster < OmniAuth::Strategies::OAuth2
+      include OmniAuth::Strategy
+      option :name, 'napster'
+
+      option :client_options, {
+        :site          => 'https://api.napster.com',
+        :token_url     => '/oauth/access_token'
+      }
+
+      uid{ raw_info['me']['id'] }
+
+      info do
+        {
+          :uid => raw_info['me']['id'],
+          :name => raw_info['me']['realName'],
+          :username => raw_info['me']['screenName'],
+          :image => raw_info['me']['avatar']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/me').parsed
+      end
+    end
+  end
+end

data/omniauth-napster.gemspec

@@ -1,33 +1,21 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'omniauth/napster/version'
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'omniauth/napster'
 
-Gem::Specification.new do |spec|
-  spec.name          = "omniauth-napster"
-  spec.version       = Omniauth::Napster::VERSION
-  spec.authors       = ["Richard Luck"]
-  spec.email         = ["rluck@rhapsody.com"]
-
-  spec.summary       = %q{omniauth-napster}
-  spec.description   = %q{omniauth-napster}
-  spec.homepage      = "https://developer.rhapsody.com/"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+Gem::Specification.new do |s|
+  s.name          = "omniauth-napster"
+  s.version       = OmniAuth::Napster::VERSION
+  s.authors       = ["Richard Luck"]
+  s.email         = ["rluck@rhapsody.com"]
+  s.description   = %q{This gem provides the OmniAuth strategy for connecting to the Napster API.}
+  s.summary       = %q{OmniAuth strategy for Napster Music Service}
+  s.homepage      = "https://github.com/Napster/omniauth-napster.git"
+  s.required_ruby_version = '~> 2.0'
+  s.license    = 'MIT'
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.3'
+  s.add_development_dependency 'rspec', '~> 3.0'
 end

data/spec/omniauth/napster_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+describe 'OmniAuth::Napster::VERSION' do
+  it "should return version number" do
+    expect(OmniAuth::Napster::VERSION).to eq('0.1.0')
+  end
+end

data/spec/omniauth/strategies/napster_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+describe 'OmniAuth::Strategies::Napster' do
+  subject do
+    OmniAuth::Strategies::Napster.new({})
+  end
+
+  context "client options" do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq("napster")
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://api.napster.com')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('/oauth/access_token')
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'omniauth-napster'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,58 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-napster
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Richard Luck
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: '1.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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: omniauth-napster
+        version: '3.0'
+description: This gem provides the OmniAuth strategy for connecting to the Napster
+  API.
 email:
 - rluck@rhapsody.com
 executables: []
@@ -61,30 +48,30 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- lib/omniauth-napster.rb
 - lib/omniauth/napster.rb
-- lib/omniauth/napster/version.rb
+- lib/omniauth/strategies/napster.rb
 - omniauth-napster.gemspec
-homepage: https://developer.rhapsody.com/
+- spec/omniauth/napster_spec.rb
+- spec/omniauth/strategies/napster_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Napster/omniauth-napster.git
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,8 +79,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: omniauth-napster
-test_files: []
+summary: OmniAuth strategy for Napster Music Service
+test_files:
+- spec/omniauth/napster_spec.rb
+- spec/omniauth/strategies/napster_spec.rb
+- spec/spec_helper.rb

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6

data/bin/console

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

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/omniauth/napster/version.rb

@@ -1,5 +0,0 @@
-module Omniauth
-  module Napster
-    VERSION = "0.0.0"
-  end
-end