guitarparty_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a53868d88895e9ae0dbb3feb498069bf1cf68d5a
+  data.tar.gz: bc50b4515b463e854b0d797a1126ae3f426a9d6b
+SHA512:
+  metadata.gz: cfb98f91ee3aac10087f4dc9c3f768efbb178518f1e34590eb0d901d71bcac49e3a0ac7982ac1310f5c5c5d2a25799c8a9a6d7bd3be6d29943f9467da8b80b49
+  data.tar.gz: c98347a2e8d8ffe7ddee00322284e1ba40e82c566a606d048f2e91372b93429052847c2af714a4d16f9ba5807f0591881902a05a2b4aaa1c73b60e73ef43af9d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Toby
+
+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,149 @@
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guitarparty_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guitarparty_client
+
+Retrieve an API key from http://www.guitarparty.com/developers/api-key/
+
+## Usage
+
+To initialize:
+
+```ruby
+require 'guitarparty_client'
+guitarparty = GuitarpartyClient.new("API-KEY")
+```
+
+To get song information:
+
+```ruby
+require 'guitarparty_client'
+guitarparty = GuitarpartyClient.new("API-KEY")
+
+guitarparty.song_by_name("Jolene")
+
+guitarparty.song_by_id(1)
+```
+Both return: 
+
+```json
+{
+    "body": "...", 
+    "chords": [...],
+    "tags": [], 
+    "title": "Jolene", 
+    "uri": "/v2/songs/5/"
+}
+```
+
+To get lyrics/chords: 
+
+
+```ruby
+require 'guitarparty_client'
+guitarparty = GuitarpartyClient.new("API-KEY")
+
+guitarparty.lyrics_by_name("Jolene")
+
+guitarparty.lyrics_by_id(1)
+```
+
+Both return the lyrics and chords:
+
+"Capo á 4.bandi
+
+Jo[Am]lene, Jo[C]lene, Jo[G]lene, Jo[Am]lene!
+I'm b[G]egging of you, please don't take my [Am]man.
+Jo[Am]lene, Jo[C]lene, Jo[G]lene, Jo[Am]lene!
+Pl[G]ease don't take him, just because you [Am]can.
+..."
+
+To get artist information: 
+
+```ruby
+require 'guitarparty_client'
+guitarparty = GuitarpartyClient.new("API-KEY")
+
+guitarparty.artist_by_name("Dolly Parton")
+
+guitarparty.artist_by_id(1)
+```
+
+Both return: 
+
+```json
+
+{
+    "objects": [
+        {
+            "bio": "Dolly Rebecca Parton (born January 19, 1946) ...", 
+            "name": "Dolly Parton", 
+            "slug": "dolly-parton", 
+            "uri": "/v2/artists/1/"
+        }
+    ],
+    "objects_count": 1
+}
+```
+
+To get only artist biography: 
+
+```ruby
+require 'guitarparty_client'
+guitarparty = GuitarpartyClient.new("API-KEY")
+
+guitarparty.bio_by_name("Dolly Parton")
+
+guitarparty.bio_by_id(1)
+```
+
+Both return a string of the full bio as shown above.
+
+To get chord information: 
+
+```ruby
+require 'guitarparty_client'
+guitarparty = GuitarpartyClient.new("API-KEY")
+
+guitarparty.get_chord("Am")
+```
+Returns chord information: 
+
+```json
+{
+  "objects": [
+    {
+      "code": "xo221o",
+      "image_url": "http://chords.guitarparty.com/chord-images/guitar_Am_xo221o.png",
+      "instrument": {
+        "name": "Guitar",
+        "safe_name": "guitar",
+        "tuning": "EADGBE"
+      },
+      "name": "Am",
+      "uri": "/v2/chords/46345/"
+    }
+  ],
+  "objects_count": 1
+}
+```
+
+And
+
+```ruby
+guitarparty.get_chord_variations("Am")
+```
+
+Returns all variations of the chord.

data/Rakefile

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

data/bin/console

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

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

data/guitarparty_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guitarparty_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guitarparty_client"
+  spec.version       = GuitarpartyClient::Version::VERSION
+  spec.authors       = ["Toby"]
+  spec.email         = ["trgray9@gmail.com"]
+
+  spec.summary       = %q{A ruby wrapper for the Guitarparty API}
+  spec.description   = %q{Provides an easy to use Ruby gem to interact with the Guitarparty API}
+  spec.homepage      = "https://github.com/trgray9/guitarparty-ruby-wrapper"
+  spec.license       = "MIT"
+
+  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.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "rest-client"
+  spec.add_dependency "mime-types"
+  spec.add_dependency "netrc"
+  spec.add_dependency "http-cookie"
+  spec.add_dependency "json"
+end

data/lib/guitarparty_client/artists.rb

@@ -0,0 +1,28 @@
+require 'rest-client'
+require 'guitarparty_client'
+require 'json'
+
+class GuitarpartyClient
+    module Artists
+
+        def artist_by_name(artist)
+            artist.gsub!(/\s/,'+')
+            RestClient.get "#{@base_url}artists/?query=#{artist}", {'Guitarparty-Api-Key' => @api_key}
+        end
+
+        def artist_by_id(id)
+            RestClient.get "#{@base_url}artists/#{id}/", {'Guitarparty-Api-Key' => @api_key}
+        end
+
+        def bio_by_name(artist)
+            artist.gsub!(/\s/,'+')
+            response = RestClient.get "#{@base_url}artists/?query=#{artist}", {'Guitarparty-Api-Key' => @api_key}
+            JSON.parse(response)["objects"][0]["bio"]
+        end
+
+        def bio_by_id(id)
+            response =RestClient.get "#{@base_url}artists/#{id}/", {'Guitarparty-Api-Key' => @api_key}
+            JSON.parse(response)["bio"]
+        end
+    end
+end

data/lib/guitarparty_client/chords.rb

@@ -0,0 +1,15 @@
+require 'rest-client'
+require 'guitarparty_client'
+
+class GuitarpartyClient
+    module Chords
+
+        def get_chord(chord)
+            RestClient.get "#{@base_url}chords/?query=#{chord}", {'Guitarparty-Api-Key' => @api_key}            
+        end
+
+        def get_chord_variations(chord)
+            RestClient.get "#{@base_url}chords/?query=#{chord}/?variations=true", {'Guitarparty-Api-Key' => @api_key}            
+        end
+    end
+end

data/lib/guitarparty_client/songs.rb

@@ -0,0 +1,25 @@
+require 'rest-client'
+require 'guitarparty_client'
+
+class GuitarpartyClient
+    module Songs
+
+        def song_by_name(name)
+            RestClient.get "#{@base_url}songs/?query=#{name}", {'Guitarparty-Api-Key' => @api_key}
+        end
+
+        def song_by_id(id)
+            RestClient.get "#{@base_url}songs/#{id}/", {'Guitarparty-Api-Key' => @api_key}
+        end
+
+        def lyrics_by_name(name)
+            response = RestClient.get "#{@base_url}songs/?query=#{name}", {'Guitarparty-Api-Key' => @api_key}
+            JSON.parse(response)["objects"][0]["body"]
+        end
+
+        def lyrics_by_id(id)
+            response = RestClient.get "#{@base_url}/songs/#{id}/", {'Guitarparty-Api-Key' => @api_key}
+            JSON.parse(response)["body"]
+        end
+    end
+end

data/lib/guitarparty_client/version.rb

@@ -0,0 +1,5 @@
+class GuitarpartyClient
+    module Version
+      VERSION = "0.1.0"
+    end
+end

data/lib/guitarparty_client.rb

@@ -0,0 +1,16 @@
+require "guitarparty_client/version"
+require "guitarparty_client/songs"
+require "guitarparty_client/artists"
+require "guitarparty_client/chords"
+
+class GuitarpartyClient
+    include Songs
+    include Artists
+    include Chords
+
+    def initialize(api_key)
+        @api_key = api_key
+        @base_url = "http://api.guitarparty.com/v2/"
+    end
+
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: guitarparty_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: mime-types
+  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: netrc
+  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: http-cookie
+  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: json
+  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'
+description: Provides an easy to use Ruby gem to interact with the Guitarparty API
+email:
+- trgray9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guitarparty_client.gemspec
+- lib/guitarparty_client.rb
+- lib/guitarparty_client/artists.rb
+- lib/guitarparty_client/chords.rb
+- lib/guitarparty_client/songs.rb
+- lib/guitarparty_client/version.rb
+homepage: https://github.com/trgray9/guitarparty-ruby-wrapper
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the Guitarparty API
+test_files: []