songlink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa1ac77f4b0749c9bd18cc382f49f77f44d9fa0b549ba8e0e8118c89cefba869
+  data.tar.gz: 61d378d93023c2916e529af88018b6345272fddc6d3bcee37fa23d97a7422bda
+SHA512:
+  metadata.gz: 5d1c0b41599b78a2fca038acb2536bb4229ee9f0217a4e7f211178d73af0ec7c245815a73f8c11c5be74725fdbaf4a46fec8e82c560b6b3ad870e693e8999d5f
+  data.tar.gz: 25a8b81db3c45f9a64382887e33793768c03c1814cafd5cbc75b06472e900b349dcd2c4fbc7c22d7f3c9453c3100196cd748583276c1534aca13d7965ecff165

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - spec/**/*
+    - vendor/**/*
+Style/Documentation:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in songlink.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 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,47 @@
+# Songlink
+
+Songlink API client library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'songlink'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install songlink
+
+## Usage
+
+```ruby
+require 'songlink'
+
+songlink = Songlink.new
+res = songlink.request({ url: 'spotify:track:0BKR0dFPDmhREewiiqGArC', userCountry: 'JP' })
+```
+
+### Setting API key
+API key is optional.
+
+Please refer to the [official API documentation](https://github.com/songlink/docs/blob/master/api-v1-alpha.1.md) on how to get API key.
+
+```ruby
+songlink = Songlink.new('your_api_key')
+```
+
+If environment variable SONGLINK_API_KEY is set in .bash_profile etc, no argument is necessary.
+
+```
+export SONGLINK_API_KEY=your_api_key
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - spec/**/*
+Style/Documentation:
+  Enabled: false
+
+Style/MethodLength:
+  Max: 15
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'songlink'
+require 'pry'
+
+Pry.start

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/songlink.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'songlink/version'
+require 'songlink/request'
+
+class Songlink
+  include Version
+  include Request
+  attr_accessor :api_key, :url, :version, :api_version
+
+  def initialize(api_key = ENV['SONGLINK_API_KEY'])
+    @version = Version.version
+    @api_version = Version.api_version
+    @api_key = api_key
+    @url = Request.base_url
+  end
+
+  def request(params = {})
+    http.get("/#{api_version}/links", _params(params))
+  end
+
+  def _params(params)
+    params['key'] = @api_key
+    params['format'] = 'json'
+    params
+  end
+  private :_params
+end

data/lib/songlink/request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Request
+  def base_url(url = 'https://api.song.link')
+    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['Accept'] = 'application/json'
+      f.headers['User-Agent'] = "ruby-songlink/#{version}"
+      f.adapter :net_http
+    end
+  end
+
+  module_function :base_url
+end

data/lib/songlink/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Version
+  def version
+    '0.1.0'
+  end
+
+  def api_version(api_version = 'v1-alpha.1')
+    api_version
+  end
+
+  module_function :version, :api_version
+end

data/songlink.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/songlink/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'songlink'
+  spec.version       = Version.version
+  spec.authors       = ['Hondallica']
+  spec.email         = ['hondallica@gmail.com']
+
+  spec.summary       = 'songlink API client library'
+  spec.homepage      = 'https://github.com/hondallica/ruby-songlink'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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', '~> 1.0.1'
+  spec.add_dependency 'faraday_middleware', '~> 1.0.0'
+  spec.add_dependency 'hashie', '~> 4.1.0'
+
+  spec.add_development_dependency 'bundler', '~>2.1.4'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.84.0'
+  spec.add_development_dependency 'webmock', '~> 3.8.3'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: songlink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hondallica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.84.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.84.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+description: 
+email:
+- hondallica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.rubocop.yml
+- bin/console
+- bin/setup
+- lib/songlink.rb
+- lib/songlink/request.rb
+- lib/songlink/version.rb
+- songlink.gemspec
+homepage: https://github.com/hondallica/ruby-songlink
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hondallica/ruby-songlink
+  source_code_uri: https://github.com/hondallica/ruby-songlink
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: songlink API client library
+test_files: []