setlistfm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a39d918809d71426702a5101a77abce087c2160
+  data.tar.gz: 7f226bf629447d2095514fc193b5d20ef0d0bf5b
+SHA512:
+  metadata.gz: 01dce6aa3e9d3dfe8918153d07fbbd474b7f8fb654b79fc2ac70340bac61af3a719f4b4c829330ecac9062988321d8b77c849e0faf41ecf2e42e54a65d582509
+  data.tar.gz: 66def2dac41d8e1940a67cc04bad7af1b1db9f54d56353d062fbc1d2b1e8431c70028dc7c297c783717518f8cfbede5b234df8b226871a132d27dbc8dae37ef0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+- 2.4.2
+- 2.3.0
+before_install: gem install bundler -v 1.15.4
+notifications:
+  slack:
+    secure: mCTEIgsHvHbsXl9BwJkD0RXMb/tPvw0dBKec0E1DCe0ek6ksx0r0VLvYM+9R/PuYHs0JTCOTWD/onWwwjZ0JYjqPca5AuEM7hRW2ZOHW+5PMLzKRcG5moOoUcnNAA8qKba3iqCnWLS7N2nwbo2m4xLPbQ70KIMFfzocjymbH1/38NKYn7h6ekQO5zQSQY1eEpgoK5xMCevwxZKIDuGM7DDxJOZBaPchOYi00ecj+cq/afgCce16Aib9vhiDcyivXSxynFQwq78ipnnuG2lORiteZbMK/IoHGP21eT7GdHi7stDg6Ia1BNm4rPqa5dh549AzD+FIhnEcUMID98A354xc+S7kaSv1G0fe0jXoL+9DDsPl1aBZ0I/zLMP1delazKVS7WZD+UsRCme80aFeMEQlbMw8+qhigeA275w83mWdNTYEvFGBfyzIB0ShpwNfiW06M8yM+GLusoXTKjuxMPG1oUKpb5xdkNN5zOM42MqufL0Sj6il0dxr7jBN7nJ/+fgpIuBUeDuFJt2iQ1ycU1yI/T/wE25ox6HQc8teyJUrdOW9WbGh8O736SsHrqCCJFBhzNOtYixqNWlFaamJXAZ83oiW5oR2gcxbRbU4rjQ8WIhBwZ9RrWnZntj/mpzQePrteSaQZAFdYhBdoRw2CfRfvlXLtJ58eBNvh+/SkIS8=

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in setlistfm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hondallica
+
+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,88 @@
+# Setlistfm [![Build Status](https://travis-ci.org/hondallica/ruby-setlistfm.svg?branch=master)](https://travis-ci.org/hondallica/ruby-setlistfm)
+
+setlist.fm API client library.
+
+## Installation
+
+    $ gem install setlistfm
+
+## Usage
+
+```ruby
+require 'setlistfm'
+```
+
+### Setting API key
+You must set the API key.
+
+Please refer to the [official API documentation](https://api.setlist.fm/docs/1.0/index.html) on how to get API key.
+
+```ruby
+setlistfm = Setlistfm.new('your_api_key')
+```
+
+If environment variable SETLISTFM_API_KEY is set in .bash_profile etc, no argument is necessary.
+
+    export SETLISTFM_API_KEY=your_api_key
+
+```ruby
+setlistfm = Setlistfm.new
+```
+
+### change API key
+
+```ruby
+setlistfm.api_key = 'new_api_key'
+```
+
+## API URL
+### get API URL
+```ruby
+setlistfm.url # https://api.setlist.fm
+```
+
+### change API URL
+```ruby
+setlistfm.url = 'http://example.com'
+```
+
+## API version
+### get API version
+```ruby
+setlistfm.api_version # 1.0
+```
+
+### change API version
+Usually you do not need to change. Use it if the API version is up.
+
+```ruby
+setlistfm.api_version = '1.1'
+```
+
+### API Resources
+It supports resources of setlist.fm API version 1.0.
+Please refer to the [official API documentation](https://api.setlist.fm/docs/1.0/index.html) for available parameters etc.
+
+```ruby
+setlistfm.artist('27e2997f-f7a1-4353-bcc4-57b9274fa9a4')
+setlistfm.artist_setlists('27e2997f-f7a1-4353-bcc4-57b9274fa9a4', {p: 2})
+setlistfm.city(5357527)
+setlistfm.search_artists({artistName: 'BABYMETAL'})
+setlistfm.search_cities({country: 'US'})
+setlistfm.search_countries
+setlistfm.search_setlists({artistMbid: '27e2997f-f7a1-4353-bcc4-57b9274fa9a4'})
+setlistfm.search_venues({name: 'US'})
+setlistfm.setlist_version('6bd6ca6e')
+setlistfm.setlist('6bd6ca6e')
+setlistfm.user('hondallica')
+setlistfm.user_attended('hondallica')
+setlistfm.user_edited('hondallica')
+setlistfm.venue('6bd6ca6e')
+setlistfm.venue_setlists('6bd6ca6e')
+```
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'setlistfm'
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/setlistfm/api_method.rb

@@ -0,0 +1,61 @@
+module APIMethod
+  def artist(mbid)
+    http.get("/rest/#{api_version}/artist/#{mbid}")
+  end
+
+  def artist_setlists(mbid, params = {})
+    http.get("/rest/#{api_version}/artist/#{mbid}/setlists", params)
+  end
+
+  def city(geoid)
+    http.get("/rest/#{api_version}/city/#{geoid}")
+  end
+
+  def search_artists(params = {})
+    http.get("/rest/#{api_version}/search/artists", params)
+  end
+
+  def search_cities(params = {})
+    http.get("/rest/#{api_version}/search/cities", params)
+  end
+
+  def search_countries(params = {})
+    http.get("/rest/#{api_version}/search/countries", params)
+  end
+
+  def search_setlists(params = {})
+    http.get("/rest/#{api_version}/search/setlists", params)
+  end
+
+  def search_venues(params = {})
+    http.get("/rest/#{api_version}/search/venues", params)
+  end
+
+  def setlist_version(version_id, params = {})
+    http.get("/rest/#{api_version}/setlist/version/#{version_id}", params)
+  end
+
+  def setlist(setlist_id, params = {})
+    http.get("/rest/#{api_version}/setlist/#{setlist_id}", params)
+  end
+
+  def user(user_id, params = {})
+    http.get("/rest/#{api_version}/user/#{user_id}", params)
+  end
+
+  def user_attended(user_id, params = {})
+    http.get("/rest/#{api_version}/user/#{user_id}/attended", params)
+  end
+
+  def user_edited(user_id, params = {})
+    http.get("/rest/#{api_version}/user/#{user_id}/edited", params)
+  end
+
+  def venue(venue_id, params = {})
+    http.get("/rest/#{api_version}/venue/#{venue_id}", params)
+  end
+
+  def venue_setlists(venue_id, params = {})
+    http.get("/rest/#{api_version}/venue/#{venue_id}/setlists", params)
+  end
+end

data/lib/setlistfm/request.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Request
+  def base_url(url = 'https://api.setlist.fm')
+    url
+  end
+
+  def http
+    Faraday.new(url: base_url) do |f|
+      f.response :mashify
+      f.response :json
+      f.request :url_encoded
+      f.request :retry, max: 5, interval: 1.0
+      f.options[:open_timeout] = 2
+      f.options[:timeout] = 5
+      f.headers['x-api-key'] = @api_key
+      f.headers['Accept'] = 'application/json'
+      f.headers['User-Agent'] = "ruby-setlistfm/#{version}"
+      f.adapter :net_http
+    end
+  end
+
+  module_function :base_url
+end

data/lib/setlistfm/version.rb

@@ -0,0 +1,11 @@
+module Version
+  def version
+    '0.1.0'.freeze
+  end
+
+  def api_version(api_version = '1.0')
+    api_version
+  end
+
+  module_function :version, :api_version
+end

data/lib/setlistfm.rb

@@ -0,0 +1,18 @@
+require 'setlistfm/version'
+require 'setlistfm/request'
+require 'setlistfm/api_method'
+
+class Setlistfm
+  include Version
+  include Request
+  include APIMethod
+  attr_accessor :api_key, :url, :version, :api_version
+
+  def initialize(api_key = ENV['SETLISTFM_API_KEY'])
+    raise 'API key is required' unless api_key
+    @version = Version.version
+    @api_version = Version.api_version
+    @api_key = api_key
+    @url = Request.base_url
+  end
+end

data/setlistfm.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'setlistfm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'setlistfm'
+  spec.version       = Version.version
+  spec.authors       = ['Hondallica']
+  spec.email         = ['hondallica@gmail.com']
+
+  spec.summary       = 'setlist.fm API client library'
+  spec.homepage      = 'https://github.com/hondallica/ruby-setlistfm'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.13.1'
+  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_dependency 'hashie'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '12.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '0.50.0'
+  spec.add_development_dependency 'webmock', '3.0.1'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: setlistfm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hondallica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+description: 
+email:
+- hondallica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/setlistfm.rb
+- lib/setlistfm/api_method.rb
+- lib/setlistfm/request.rb
+- lib/setlistfm/version.rb
+- setlistfm.gemspec
+homepage: https://github.com/hondallica/ruby-setlistfm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: setlist.fm API client library
+test_files: []