spotifysearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15fd8da9197fda745bfe9f6a45de61b0f56888e0
+  data.tar.gz: 31fd926a0eeb6785e8235635559f25ab60f40c66
+SHA512:
+  metadata.gz: 43e744924569857776d33531298fcd97028552c91b2c4f2c917386ae4800b20242d6f729744354c43d3388cf83912b01ae396fe0556cc05a6287f600ad1e4883
+  data.tar.gz: e3aa999c5abe649f05723b90c742dea4d9ceceeaee3a853eedfd5bfeed6ff2db8816ebf15f6dd86c224649faaca62547402b97a4641397d1aedff6e6932d3fdf

data/.gitignore

@@ -0,0 +1,6 @@
+config/
+coverage/
+spec/fixtures/
+spec/coverage/
+spec/fixtures/cassettes
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,7 @@
+---
+AllCops:
+  TargetRubyVersion: 2.3
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Tab:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2
+  - 2.1
+branches:
+  only:
+    - master
+    - travis
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Lemon555
+
+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,42 @@
+# Spotifysearch Gem 
+[![Build Status](https://travis-ci.org/Lemon555/Spotify_Card.svg?branch=master)](https://travis-ci.org/Lemon555/Spotify_Card)
+
+Spotifysearch Gem helps you generate your song into a picture to share on social media!
+* Auto search for nice album artwork
+* Change the image you like
+* Add comments on the image and songs to create your own awesome artwork!
+* Share on multiple social network to express your music loving soul!
+
+##Install
+
+If you are working on a project, add this to your Gemfile: ```gem 'spotifysearch'```
+
+For installation from command line:
+
+```
+$ gem install spotifysearch
+```
+
+##Usage
+
+Require Spotifysearch gem in your code: require 'Spotifysearch'
+
+You should use a track name as the input argument.
+
+**Notice that you have to use plus sign ("+") instead of a blank to combine each word.
+
+For example, If "Eyes Shut" is the track name you want to search, "Eyes+Shut" is the correct type of input. 
+
+See the following example code for more usage details:
+
+```
+search = Spotify::Search.find(user_input)
+puts 'Search Result:'
+search.each_value do |songinfo|
+		puts "track: #{songinfo.track_name}"
+		puts "artist: #{songinfo.artist_name}"
+		puts "album: #{songinfo.album_name}"
+		puts "img_url: #{songinfo.imgs[0]}"
+		puts
+end
+```

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake/testtask'
+
+task default: :spec
+
+desc 'run tests'
+task :spec do
+  sh 'ruby spec/card_spec.rb'
+end
+
+desc 'delete cassette fixtures'
+task :wipe do
+  sh 'rm spec/fixtures/cassettes/*.yml' do |ok, _|
+    puts(ok ? 'Cassettes deleted' : 'No casseettes found')
+  end
+end
+
+namespace :quality do
+  desc 'run all quality checks'
+  task all: [:rubocop, :flog, :flay]
+
+  task :flog do
+    sh 'flog lib/'
+  end
+
+  task :flay do
+    sh 'flay lib/'
+  end
+
+  task :rubocop do
+    sh 'rubocop'
+  end
+end

data/bin/spotifysearch

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'spotifysearch'
+
+user_input = ARGV[0]
+unless user_input
+  puts 'USAGE: spotifysearch [user_input]'
+  exit(1)
+end
+
+search = Spotify::Search.find(user_input)
+puts 'Search Result:'
+search.each_value do |songinfo|
+		puts "track: #{songinfo.track_name}"
+		puts "artist: #{songinfo.artist_name}"
+		puts "album: #{songinfo.album_name}"
+		puts "img_url: #{songinfo.imgs[0]}"
+		puts
+end

data/lib/spotifysearch.rb

@@ -0,0 +1,2 @@
+files = Dir.glob(File.join(File.dirname(__FILE__), 'spotifysearch/*.rb'))
+files.each { |lib| require_relative lib }

data/lib/spotifysearch/api_helper.rb

@@ -0,0 +1,42 @@
+require 'http'
+require_relative 'song'
+require_relative 'spotify_api'
+
+module Spotify
+  # Search for a specfic track
+  class SongsHash
+    attr_accessor :songs_hash
+
+    # Decompose the search_result and create a "Song" object for each album
+    def self.create(search_result)
+      @songs_hash = {}
+      search_result.map do |song|
+        @songs_hash[song['id']] = {
+          id: song['id'], track_name: song['name'],
+          link: song['external_urls']['spotify'], album: song['album']['name'],
+          artist: get_artists(song['artists']),
+          imgs: get_album_imgs(song['album']['images'])
+        }
+      end
+      @songs_hash
+    end
+
+    # We don't flay get_artists and get_album_imgs method cause for future uses.
+    def self.get_artists(artists)
+      # Return an array including all artists of the song
+      arr = []
+      artists.each do |artist|
+        arr.push(artist['name'])
+      end
+      arr
+    end
+
+    def self.get_album_imgs(images)
+      # Return an array including all url of each size of image
+      # imgs[0]:L, imgs[1]:M, imgs[2]:S
+      imgs = []
+      images.each { |img| imgs.push(img['url']) }
+      imgs
+    end
+  end
+end

data/lib/spotifysearch/search.rb

@@ -0,0 +1,21 @@
+require_relative 'spotify_api'
+require_relative 'song'
+
+module Spotify
+  # Create a Song object
+  class Search
+    attr_accessor :songs
+
+    def initialize(search_data)
+      @songs = {}
+      search_data.each do |key, value|
+        @songs[key] = Spotify::Song.new(data: value)
+      end
+    end
+
+    def self.find(input)
+      search_data = Spotify::SpAPI.search_feed(input)
+      new(search_data).songs
+    end
+  end
+end

data/lib/spotifysearch/song.rb

@@ -0,0 +1,20 @@
+module Spotify
+  # Create a Song object
+  class Song
+    attr_accessor :track_name, :track_link, :album_name, :artist_name, :imgs
+
+    def initialize(data: nil)
+      load_data(data)
+    end
+
+    private
+
+    def load_data(data)
+      @track_name = data[:track_name]
+      @track_link = data[:link]
+      @album_name = data[:album]
+      @artist_name = data[:artist]
+      @imgs = data[:imgs]
+    end
+  end
+end

data/lib/spotifysearch/spotify_api.rb

@@ -0,0 +1,22 @@
+require 'http'
+require 'json'
+require_relative 'api_helper'
+
+module Spotify
+  # Service for all Spotify API calls
+  class SpAPI
+    SP_URL = 'https://api.spotify.com'.freeze
+    API_VER = 'v1'.freeze
+    SP_API_URL = URI.join(SP_URL, "#{API_VER}/")
+    SEARCH_TYPE = 'track'.freeze
+
+    def self.search_feed(input)
+      search_response = HTTP.get(
+        URI.join(SP_API_URL, 'search'),
+        params: { q: input, type: SEARCH_TYPE }
+      )
+      rawfeed = JSON.parse(search_response.to_s)['tracks']['items']
+      Spotify::SongsHash.create(rawfeed)
+    end
+  end
+end

data/lib/spotifysearch/version.rb

@@ -0,0 +1,3 @@
+module Spotify
+  VERSION = '0.1.0'.freeze
+end

data/spec/README.md

@@ -0,0 +1 @@
+# This is test's README.md

data/spec/card_spec.rb

@@ -0,0 +1,43 @@
+require_relative 'spec_helper'
+
+describe 'card specifications' do
+  VCR.configure do |c|
+    c.cassette_library_dir = CASSETTES_FOLDER
+    c.hook_into :webmock
+  end
+
+  before do
+    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
+    @spotify_api = Spotify::SpAPI.new
+    @track_id = '2xzzSkFGtf0w5ZATRYa1Tg'
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  it 'should be able to get a hash from SpAPI Class' do
+    search = Spotify::Search.find('Eyes Shut')
+    search.is_a?(Hash)
+  end
+
+  it 'should be able to get the name of a track' do
+    search = Spotify::Search.find('Eyes Shut')
+    search[@track_id].track_name = 'Eyes Shut'
+  end
+
+  it 'should be able to get a list of name of artist' do
+    search = Spotify::Search.find('Eyes Shut')
+    search[@track_id].artist_name = 'Years & Years'
+  end
+
+  it 'should be able to get the name of the album' do
+    search = Spotify::Search.find('Eyes Shut')
+    search[@track_id].album_name = 'Communion (Deluxe)'
+  end
+
+  it 'should be able to get a array of images' do
+    search = Spotify::Search.find('Eyes Shut')
+    search[@track_id].imgs.is_a?(Array)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'yaml'
+require 'minitest/autorun'
+require 'minitest/rg'
+require 'vcr'
+require 'webmock'
+
+require_relative '../lib/spotifysearch'
+
+FIXTURES_FOLDER = 'spec/fixtures'.freeze
+CASSETTES_FOLDER = "#{FIXTURES_FOLDER}/cassettes".freeze
+CASSETTE_FILE = 'spotify_api'.freeze
+# CREDENTIALS = YAML.load(File.read('../config/credentials.yml'))
+# RESULT_FILE = "#{FIXTURES_FOLDER}/results.yml"
+# SPOTIFY_RESULT = YAML.load(File.read(RESULT_FILE))

data/spotifysearch.gemspec

@@ -0,0 +1,31 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'spotifysearch/version'
+
+Gem::Specification.new do |s|
+  s.name        =  'spotifysearch'
+  s.version     =  Spotify::VERSION
+
+  s.summary     =  "Get song's search result from Spotify"
+  s.description =  'Extracts name, link, album, artist, imgs from a search'
+  s.authors     =  ['Lemon555']
+  s.email       =  ['wenyun.she@iss.nthu.edu.tw']
+
+  s.files       =  `git ls-files`.split("\n")
+  s.test_files  =  `git ls-files -- spec/*`.split("\n")
+  s.executables << 'spotifysearch'
+
+  s.add_runtime_dependency 'http', '~> 2.0'
+
+  s.add_development_dependency 'minitest', '~> 5.9'
+  s.add_development_dependency 'minitest-rg', '~> 5.2'
+  s.add_development_dependency 'rake', '~> 10.4'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 2.1'
+  s.add_development_dependency 'simplecov', '~> 0.12'
+  s.add_development_dependency 'flog', '~> 4.4'
+  s.add_development_dependency 'flay', '~> 2.8'
+  s.add_development_dependency 'rubocop', '~> 0.43'
+
+  s.homepage    =  'https://github.com/Lemon555/Spotify_Card'
+  s.license     =  'MIT'
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: spotifysearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lemon555
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+description: Extracts name, link, album, artist, imgs from a search
+email:
+- wenyun.she@iss.nthu.edu.tw
+executables:
+- spotifysearch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/spotifysearch
+- lib/spotifysearch.rb
+- lib/spotifysearch/api_helper.rb
+- lib/spotifysearch/search.rb
+- lib/spotifysearch/song.rb
+- lib/spotifysearch/spotify_api.rb
+- lib/spotifysearch/version.rb
+- spec/README.md
+- spec/card_spec.rb
+- spec/spec_helper.rb
+- spotifysearch.gemspec
+homepage: https://github.com/Lemon555/Spotify_Card
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Get song's search result from Spotify
+test_files:
+- spec/README.md
+- spec/card_spec.rb
+- spec/spec_helper.rb