band_page 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bandpage.gemspec
+gemspec
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 James Brennan
+
+MIT License
+
+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,25 @@
+# BandPage
+
+A ruby wrapper for the BandPage API.
+
+## Installation
+
+Add this to your gemfile:
+	
+	gem 'band_page'
+
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Contributions are welcome and encouraged. Please write specs for any changes that you would like merged. Thanks!
+
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bandpage.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'band_page/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "band_page"
+  gem.version       = BandPage::VERSION
+  gem.authors       = ["James Brennan"]
+  gem.email         = ["james@carbonfive.com", "brennanmusic@gmail.com"]
+  gem.description   = 'Wrapper for BandPage API'
+  gem.summary       = 'Wrapper for BandPage API - https://developers.bandpage.com/docs'
+  gem.homepage      = "https://github.com/jamesBrennan/bandpage_api"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('httparty')
+  gem.add_dependency('recursive-open-struct')
+  gem.add_development_dependency('fakeweb')
+end

data/lib/band_page.rb

@@ -0,0 +1,11 @@
+require "band_page/version"
+require "band_page/config"
+require "band_page/token"
+require "band_page/client"
+
+module BandPage
+  class AuthorizationError < StandardError; end
+  class ResourceNotFoundError < StandardError; end
+  class ServerError < StandardError; end
+  class ServiceUnavailableError < StandardError; end
+end

data/lib/band_page/client.rb

@@ -0,0 +1,86 @@
+require 'httparty'
+require 'recursive-open-struct'
+
+module BandPage
+  class Client
+    CONNECTIONS = [:emails, :events, :genres, :tracks, :photos, :videos, :websites]
+    BASE_URL = 'https://api-read.bandpage.com/'
+
+    attr_accessor :config, :token
+    def initialize(config)
+      @config = config
+    end
+
+    def band
+      get
+    end
+
+    def method_missing(m, *args, &block)
+      return get(m) if CONNECTIONS.include?(m)
+      super
+    end
+
+    private
+
+    def authenticate
+      resp = HTTParty.post("#{BASE_URL}/token",
+                               basic_auth: {
+                                 username: config.client_id,
+                                 password: config.secret_key
+                               },
+                               query: {
+                                 client_id: config.client_id,
+                                 grant_type: 'client_credentials'
+                               })
+      if [200, 202].include? resp.code
+        @token = BandPage::Token.new(resp['access_token'], resp['expires_in'])
+      else
+        error_response resp
+      end
+    end
+
+    def get(connection = nil)
+      authenticate if @token.nil? || @token.expired?
+      resp = HTTParty.get(url(connection), headers:
+        {"Authorization" => "Bearer #{@token.string}"}
+      )
+      if [200, 202].include? resp.code
+        return resp if connection.nil?
+        load_response_objects resp
+      else
+        error_response resp
+      end
+    end
+
+    def load_response_objects(response)
+      response.parsed_response.map do |obj|
+        RecursiveOpenStruct.new(obj)
+      end
+    end
+
+    def error_response(resp)
+      raise case resp.code
+        when 401
+          BandPage::AuthorizationError
+        when 404
+          BandPage::ResourceNotFoundError
+        when 500
+          BandPage::ServerError.new resp['error']
+        else
+          StandardError.new("An unknown error occurred when attempting to parse: #{resp.inspect}")
+      end
+    end
+
+    def url(connection)
+      connection.nil? ? band_url : "#{band_url}/#{connection}"
+    end
+
+    def band_url
+      @band_url ||= "#{BASE_URL}/#{bid}"
+    end
+
+    def bid
+      config.band_id
+    end
+  end
+end

data/lib/band_page/config.rb

@@ -0,0 +1,14 @@
+# Config object which exists primarily to document the
+# information needed to interact with the BandPage API
+module BandPage
+  class Config
+    attr_accessor :app_id, :client_id, :secret_key, :band_id
+
+    def initialize(conf)
+      @app_id = conf[:app_id]
+      @client_id = conf[:client_id]
+      @secret_key = conf[:secret_key]
+      @band_id = conf[:band_id]
+    end
+  end
+end

data/lib/band_page/token.rb

@@ -0,0 +1,13 @@
+module BandPage
+  class Token
+    attr_accessor :expires_at, :string
+    def initialize(string, expires_in)
+      @string = string
+      @expires_at = Time.now + expires_in.to_i
+    end
+
+    def expired?
+      @expires_at < Time.now
+    end
+  end
+end

data/lib/band_page/version.rb

@@ -0,0 +1,3 @@
+module BandPage
+  VERSION = "0.0.1"
+end

data/spec/api_responses.rb

@@ -0,0 +1,23 @@
+module BandPage
+  module RecordedApiResponses
+    def self.tracks
+      "HTTP/1.1 200 OK\r\nContent-Type: application/json;charset=UTF-8\r\nDate: Tue, 05 Mar 2013 23:06:07 GMT\r\nLink: <https://api-read.bandpage.com/164527841654870016/tracks?offset=50&access_token=AAAAAQAAAAECluDXQ8JgAAKW4NcngmAAApbgKZSCMAAAAAAAAAAAAAAAAT09BFezUoRLKkkXgLrchDm6DOYYA0tY5K0=>;rel=\"next\";type=\"application/json\";title=\"Next Results\"\r\nServer: Apache-Coyote/1.1\r\nContent-Length: 2241\r\nConnection: keep-alive\r\n\r\n[{\"albumArt\":{\"original\":{\"source\":\"https://i1.sndcdn.com/artworks-000037081241-3xfo2g-large.jpg?923db0b\",\"width\":0,\"height\":0},\"large\":{\"source\":\"https://i1.sndcdn.com/artworks-000037081241-3xfo2g-large.jpg?923db0b\",\"width\":0,\"height\":0},\"small\":{\"source\":\"https://i1.sndcdn.com/artworks-000037081241-3xfo2g-large.jpg?923db0b\",\"width\":0,\"height\":0},\"thumb\":{\"source\":\"https://i1.sndcdn.com/artworks-000037081241-3xfo2g-large.jpg?923db0b\",\"width\":0,\"height\":0}},\"artworkUrl\":\"\",\"bid\":\"164528215925219328\",\"downloadCount\":\"0\",\"downloadUrl\":\"\",\"downloadable\":false,\"duration\":\"149617\",\"permalinkUrl\":\"http://soundcloud.com/james-the-giant/long-days-of-longing\",\"playCount\":\"97\",\"provider\":\"soundcloud\",\"providerId\":\"72769600\",\"purchasable\":false,\"purchaseUrl\":\"\",\"streamUrl\":\"http://api.soundcloud.com/tracks/72769600/stream?secret_token=s-JiJNd&consumer_key=P0OieYzyPHtoHulKAJOjlA\",\"title\":\"Long Days of Longing\",\"type\":\"Track\"},{\"albumArt\":{\"original\":{\"source\":\"\",\"width\":0,\"height\":0},\"large\":{\"source\":\"\",\"width\":0,\"height\":0},\"small\":{\"source\":\"\",\"width\":0,\"height\":0},\"thumb\":{\"source\":\"\",\"width\":0,\"height\":0}},\"artworkUrl\":\"\",\"bid\":\"164528200733437952\",\"downloadCount\":\"0\",\"downloadUrl\":\"\",\"downloadable\":false,\"duration\":\"185982\",\"permalinkUrl\":\"http://soundcloud.com/james-the-giant/wave-hello-wave-goodbye\",\"playCount\":\"79\",\"provider\":\"soundcloud\",\"providerId\":\"72770796\",\"purchasable\":false,\"purchaseUrl\":\"\",\"streamUrl\":\"http://api.soundcloud.com/tracks/72770796/stream?secret_token=s-Z07gg&consumer_key=P0OieYzyPHtoHulKAJOjlA\",\"title\":\"Wave Hello, Wave Goodbye\",\"type\":\"Track\"},{\"albumArt\":{\"original\":{\"source\":\"\",\"width\":0,\"height\":0},\"large\":{\"source\":\"\",\"width\":0,\"height\":0},\"small\":{\"source\":\"\",\"width\":0,\"height\":0},\"thumb\":{\"source\":\"\",\"width\":0,\"height\":0}},\"artworkUrl\":\"\",\"bid\":\"165717578767949824\",\"downloadCount\":\"0\",\"downloadUrl\":\"\",\"downloadable\":false,\"duration\":\"181462\",\"permalinkUrl\":\"http://soundcloud.com/james-the-giant/seven-secret-words\",\"playCount\":\"52\",\"provider\":\"soundcloud\",\"providerId\":\"73134819\",\"purchasable\":false,\"purchaseUrl\":\"\",\"streamUrl\":\"http://api.soundcloud.com/tracks/73134819/stream?secret_token=s-njzbu&consumer_key=P0OieYzyPHtoHulKAJOjlA\",\"title\":\"Seven Secret Words\",\"type\":\"Track\"}]"
+    end
+
+    def self.authenticate
+      "HTTP/1.1 200 OK\r\nContent-Type: application/json;charset=UTF-8\r\nDate: Wed, 06 Mar 2013 00:18:51 GMT\r\nServer: Apache-Coyote/1.1\r\nContent-Length: 151\r\nConnection: keep-alive\r\n\r\n{\"access_token\":\"AAAAAQAAAAECluDXQ8JgAAKW4NcngmAAApbgKZSCMAAAAAAAAAAAAAAAAT09R4rH6yW52T8rDPD3C__Hnl-O6Bw5MtM=\",\"token_type\":\"bearer\",\"expires_in\":3600}"
+    end
+
+    def self.server_error
+      "HTTP/1.1 500 Internal Server Error\r\nContent-Type: application/json;charset=ISO-8859-1\r\nDate: Wed, 06 Mar 2013 01:05:13 GMT\r\nServer: Apache-Coyote/1.1\r\nContent-Length: 241\r\nConnection: keep-alive\r\n\r\n{\"error\":\"Failed to convert value of type 'java.lang.String' to required type 'com.rootmusic.core.domain.RmidBackedObject'; nested exception is java.lang.NumberFormatException: A rmid needs to be of type Long. Recived 164527841654870016456\"}"
+    end
+
+    def self.service_unavailable
+      "HTTP/1.1 503 Service Unavailable\r\nDate: Wed, 06 Mar 2013 01:09:50 GMT\r\nServer: Apache-Coyote/1.1\r\nContent-Length: 0\r\nConnection: keep-alive\r\n\r\n"
+    end
+
+    def self.not_found
+      "HTTP/1.1 404 Not Found\r\nDate: Wed, 06 Mar 2013 01:09:50 GMT\r\nServer: Apache-Coyote/1.1\r\nContent-Length: 0\r\nConnection: keep-alive\r\n\r\n"
+    end
+  end
+end

data/spec/band_page/client_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'api_responses'
+
+describe BandPage::Client do
+  let(:subject) {
+    BandPage::Client.new(config)
+  }
+
+  let(:config) {
+    BandPage::Config.new(
+      app_id: '1',
+      client_id: '2a',
+      secret_key: '3b',
+      band_id: '2'
+    )
+  }
+
+  before do
+    subject.token = BandPage::Token.new('sometoken', 5000)
+  end
+
+  describe 'connections' do
+    it 'creates a method for each connection which delegates to get' do
+      BandPage::Client::CONNECTIONS.each do |connection|
+        subject.should_receive(:get).with(connection)
+        subject.send(connection)
+      end
+    end
+  end
+
+  # This is a stand in for any of the connection methods
+  # they all behave the same
+  describe '.tracks' do
+    before do
+      FakeWeb.register_uri(:get, subject.send(:url, :tracks),
+                           response: BandPage::RecordedApiResponses.tracks)
+    end
+    it 'returns tracks' do
+      subject.tracks.first.type.should == "Track"
+    end
+  end
+
+  context '401' do
+    before do
+      FakeWeb.register_uri(:get, subject.send(:url, :tracks),
+                            body: "{'error':'invalid_token','error_description':'Invalid token signature'}",
+                            status: ['401', 'UNAUTHORIZED'])
+    end
+
+    it 'raises an authorization error' do
+      expect {
+        subject.tracks
+      }.to raise_error(BandPage::AuthorizationError)
+    end
+  end
+
+  context '404' do
+    before do
+      FakeWeb.register_uri(:get, subject.send(:url, :tracks),
+                           response: BandPage::RecordedApiResponses.not_found)
+    end
+
+    it 'raises a resource not found error' do
+      expect {
+        subject.tracks
+      }.to raise_error(BandPage::ResourceNotFoundError)
+    end
+  end
+
+  context '500' do
+    before do
+      FakeWeb.register_uri(:get, subject.send(:url, :tracks),
+                           response: BandPage::RecordedApiResponses.server_error)
+    end
+
+    it 'raises a server error' do
+      expect {
+        subject.tracks
+      }.to raise_error(BandPage::ServerError)
+    end
+  end
+
+  context '503' do
+    before do
+      FakeWeb.register_uri(:get, subject.send(:url, :tracks),
+                           response: BandPage::RecordedApiResponses.service_unavailable)
+      it 'reases a service unavailable error' do
+        expect {
+          subject.tracks
+        }.to raise_error(BandPage::ServiceUnavailableError)
+      end
+    end
+  end
+
+end
+

data/spec/band_page/token_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe BandPage::Token do
+  let(:subject) { BandPage::Token }
+
+  before do
+    @time = Time.now
+    Time.stub(:now).and_return(@time)
+  end
+
+  describe '.initialize' do
+    it 'sets expires_at' do
+      token = subject.new('tokenstring', '3600')
+      token.expires_at.should eq(@time + 3600)
+    end
+  end
+
+  describe '#expired' do
+    it 'is true if expires_at is a time in the past' do
+      token = subject.new('tokenstring', '-3600')
+      token.expired?.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'band_page'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: band_page
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Brennan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for BandPage API
+email:
+- james@carbonfive.com
+- brennanmusic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bandpage.gemspec
+- lib/band_page.rb
+- lib/band_page/client.rb
+- lib/band_page/config.rb
+- lib/band_page/token.rb
+- lib/band_page/version.rb
+- spec/api_responses.rb
+- spec/band_page/client_spec.rb
+- spec/band_page/token_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jamesBrennan/bandpage_api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wrapper for BandPage API - https://developers.bandpage.com/docs
+test_files:
+- spec/api_responses.rb
+- spec/band_page/client_spec.rb
+- spec/band_page/token_spec.rb
+- spec/spec_helper.rb