phishin-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ee4488e118bd6ff4bbc4845ee972089ff2c4a44
+  data.tar.gz: 42a82c1d9691889b32fe366d698bd952ac0336ea
+SHA512:
+  metadata.gz: 45a63268185f2a1a7c4ad3c0afee7fa04d16266c5f02a7502942195acfcb0d042e4567a4172fd4b4ca5fde42a3f60e7d366dc9988a8b10063034279e23999e65
+  data.tar.gz: 2bf0d5f634419099acc1c80f70817585c7151a29147fc1087d6048d376de2ed735bcba8eb90c6b157af32b2c89c6a52d6db878691ed42db7e97a9012abfd4501

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Bird
+
+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,33 @@
+# Phish.in API Client
+
+Talks to the http://phish.in API. Has built-in caching.
+
+- [README](https://github.com/alexebird/phishin-client/blob/master/README.md)
+- [Documentation](http://rubydoc.info/gems/phishin-client)
+- [Phish.in API documentation](http://phish.in/api-docs)
+
+## Installation
+
+    gem install phishin-client
+
+
+## Getting Started
+
+```ruby
+require 'phishin-client'
+doglogger = Logger.new
+c = Phishin::Client.new log: true, logger: doglogger
+
+response = c.get_tracks(page: 1, per_page: 40)  # Phishin::Api::Response instance
+json_hash = response.data
+```
+
+## License
+
+Please see [LICENSE](https://github.com/alexebird/phishin-client/blob/master/LICENSE.txt).
+
+
+## Author
+
+Alex Bird [@alexebird](https://twitter.com/alexebird).
+Big thanks to [@phish_in](https://twitter.com/phish_in).

data/Rakefile

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

data/lib/phishin/api/response.rb

@@ -0,0 +1,35 @@
+module Phishin
+  module Api
+    class Response
+      attr_reader :http_status
+      attr_reader :total_entries
+      attr_reader :total_pages
+      attr_reader :page
+      attr_reader :data
+      attr_reader :url
+
+      def initialize(url, response_data)
+        @url = url
+        @success = response_data['success']
+
+        if success?
+          @total_entries = response_data['total_entries']
+          @total_pages = response_data['total_pages']
+          @page = response_data['page']
+          @data = response_data['data']
+        else
+          @message = response_data['message']
+          raise Phishin::Client::UnsuccessfulResponseError.new(url, @message)
+        end
+      end
+
+      def [](key)
+        return @data[key]
+      end
+
+      def success?
+        return @success == true
+      end
+    end
+  end
+end

data/lib/phishin/api/v1.rb

@@ -0,0 +1,121 @@
+module Phishin
+  module Api
+    module V1
+      BASE_URL = 'http://phish.in/api/v1'
+      HEADERS = { 'accept' => 'application/json' }
+      DEFAULT_PARAMS = %i[page per_page sort_attr sort_dir]
+
+      # @param id_or_slug [String,Integer] track id or slug
+      def get_track(id_or_slug)
+        check_id_arg('track', id_or_slug)
+        perform_get_request('tracks/%s.json' % id_or_slug.to_s)
+      end
+
+      # @option opts [Integer] :page The desired page
+      # @option opts [Integer] :per_page Results per page
+      def get_tracks(opts={})
+        perform_get_request('tracks.json', select_params(opts, DEFAULT_PARAMS))
+      end
+
+
+
+      # @param (see #get_track)
+      def get_show(id_or_slug)
+        check_id_arg('show', id_or_slug)
+        perform_get_request('shows/%s.json' % id_or_slug.to_s)
+      end
+
+      # @option (see #get_tracks)
+      def get_shows(opts={})
+        perform_get_request('shows.json', select_params(opts, DEFAULT_PARAMS))
+      end
+
+      # @param show_date [String] a show date in the format YYYY-MM-DD
+      def get_show_on_date(show_date)
+        raise Phishin::Client::Error, "invalid argument: show_date must match YYYY-MM-DD" unless show_date && show_date =~ /\d{4}-\d{2}-\d{2}/
+        perform_get_request('show-on-date/%s.json' % show_date)
+      end
+
+
+
+      # @param (see #get_track)
+      def get_song(id_or_slug)
+        check_id_arg('song', id_or_slug)
+        perform_get_request('songs/%s.json' % id_or_slug.to_s)
+      end
+
+      # @option (see #get_tracks)
+      def get_songs(opts={})
+        perform_get_request('songs.json', select_params(opts, DEFAULT_PARAMS))
+      end
+
+
+
+      # @param (see #get_track)
+      def get_tour(id_or_slug)
+        check_id_arg('tour', id_or_slug)
+        perform_get_request('tours/%s.json' % id_or_slug.to_s)
+      end
+
+      # @option (see #get_tracks)
+      def get_tours(opts={})
+        perform_get_request('tours.json', select_params(opts, DEFAULT_PARAMS))
+      end
+
+
+
+      # @param (see #get_track)
+      def get_venue(id_or_slug)
+        check_id_arg('venue', id_or_slug)
+        perform_get_request('venues/%s.json' % id_or_slug.to_s)
+      end
+
+      # @option (see #get_tracks)
+      def get_venues(opts={})
+        perform_get_request('venues.json', select_params(opts, DEFAULT_PARAMS))
+      end
+
+
+
+      def get_eras
+        perform_get_request('eras.json')
+      end
+
+      def get_years
+        perform_get_request('years.json')
+      end
+
+
+
+      # @api private
+      def select_params(opts, keys)
+        params = {}
+        keys.each do |key|
+          params[key] = opts[key] if opts.key?(key)
+        end
+        return params
+      end
+
+      # @api private
+      def assert_response_data_field(response)
+        raise Phishin::Client::EmptyResponseError.new(response.url) if !response.data
+      end
+
+      # @api private
+      def perform_get_request(path, params={})
+        url = [BASE_URL, path].join("/")
+        logger.info "phish.in api GET url=#{url} params=#{params}" if logger
+        response = RestClient.get(url, HEADERS.merge(params: params))
+        resp = Phishin::Api::Response.new(url, Oj.load(response.to_s))
+        assert_response_data_field(resp)
+        return resp
+      end
+
+      # @api private
+      def check_id_arg(resource_name, val)
+        raise Phishin::Client::Error, "invalid argument: must pass #{resource_name} id or slug" unless val
+      end
+    end
+  end
+end
+

data/lib/phishin/api.rb

@@ -0,0 +1,4 @@
+module Phishin
+  module Api
+  end
+end

data/lib/phishin/client/client.rb

@@ -0,0 +1,25 @@
+module Phishin
+  module Client
+    class Client
+
+      include Phishin::Api::V1
+
+      attr_accessor :logger
+
+      DEFAULT_LOGGER = lambda do
+        require 'logger'
+        logger = Logger.new(STDOUT)
+        logger.progname = 'phishin-client'
+        logger
+      end
+
+      # @option opts [Boolean] :log Enable/disable logging
+      # @option opts [Object] :logger Logger-compatible object instance to use
+      def initialize(opts={})
+        opts[:log] = true if !opts.key?(:log)
+        @logger = opts[:log] ? (opts[:logger] || DEFAULT_LOGGER.call()) : nil
+      end
+    end
+  end
+end
+

data/lib/phishin/client/errors.rb

@@ -0,0 +1,31 @@
+module Phishin
+  module Client
+    class Error < StandardError ; end
+
+    class TrackNotFoundError < StandardError
+      def initialize(show_date, track_id_or_slug)
+        super("phish.in api could not find track with show_date=#{show_date} track_id_or_slug=#{track_id_or_slug} (possibly the 'missing track' issue)")
+      end
+    end
+
+    # Raised when there is no response body
+    class EmptyResponseError < StandardError
+      attr_reader :url
+
+      def initialize(url)
+        @url = url
+        super("phish.in api response body was empty for url=#{url}")
+      end
+    end
+
+    class UnsuccessfulResponseError < StandardError
+      attr_reader :url
+
+      def initialize(url, message)
+        @url = url
+        super("phish.in api response body has success=false. message='#{message}'")
+      end
+    end
+  end
+end
+

data/lib/phishin/client/version.rb

@@ -0,0 +1,6 @@
+module Phishin
+  module Client
+    VERSION = '0.0.1'
+  end
+end
+

data/lib/phishin/client.rb

@@ -0,0 +1,23 @@
+require 'rest-client'
+require 'oj'
+
+require 'phishin/api'
+require 'phishin/api/v1'
+require 'phishin/api/response'
+
+require 'phishin/client/version'
+require 'phishin/client/client'
+require 'phishin/client/errors'
+
+module Phishin
+  module Client
+
+    # Wrapper for {::Phishin::Client::Client#initialize}.
+    #
+    def new(opts={})
+      Phishin::Client::Client.new(opts)
+    end
+    extend self
+  end
+end
+

data/lib/phishin-client.rb

@@ -0,0 +1 @@
+require 'phishin/client'

data/phishin-client.gemspec

@@ -0,0 +1,63 @@
+# encoding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'date'
+require 'phishin/client/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'phishin-client'
+  gem.version     = Phishin::Client::VERSION
+  gem.date        = Date.today.to_s
+  gem.licenses    = ['MIT']
+  gem.authors     = ['Alexander Bird']
+  gem.email       = ['alexebird@gmail.com']
+  gem.homepage    = 'https://github.com/alexebird/phishin-client'
+  gem.summary     = %q{Phish.in API client}
+  gem.description = %q{Client for http://phish.in Phish streaming API.}
+
+  gem.required_ruby_version     = '>= 1.9.3'
+
+  gem.add_runtime_dependency 'rest-client', '~> 1.6.7'
+  gem.add_runtime_dependency 'oj', '~> 2.1.7'
+  #gem.add_runtime_dependency 'nokogiri', '~> 1.6.0'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  #gem.add_development_dependency 'redcarpet', '~> 3.0'
+  #gem.add_development_dependency 'simplecov', '~> 0.7.1'
+
+  gem.files       = `git ls-files`.split($/)
+  gem.test_files  = gem.files.grep(%r{^spec/})
+
+  gem.require_paths = ['lib']
+end
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date'
+require 'phishin/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phishin-client"
+  spec.version       = Phishin::Client::VERSION
+  spec.date          = Date.today.to_s
+  spec.authors       = ["Alex Bird"]
+  spec.email         = ["alexebird@gmail.com"]
+  spec.summary       = %q{Phish.in API client}
+  spec.description   = %q{Client for http://phish.in Phish streaming API.}
+  spec.homepage      = "https://github.com/alexebird/phishin-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "rest-client", "~> 1.6.7"
+  spec.add_runtime_dependency "oj", "~> 2.1.7"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard", "~> 0.8"
+end
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: phishin-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Bird
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Client for http://phish.in Phish streaming API.
+email:
+- alexebird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/phishin-client.rb
+- lib/phishin/api.rb
+- lib/phishin/api/response.rb
+- lib/phishin/api/v1.rb
+- lib/phishin/client.rb
+- lib/phishin/client/client.rb
+- lib/phishin/client/errors.rb
+- lib/phishin/client/version.rb
+- phishin-client.gemspec
+homepage: https://github.com/alexebird/phishin-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.0.14
+signing_key: 
+specification_version: 4
+summary: Phish.in API client
+test_files: []
+has_rdoc: