ruby-mopidy 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 348dab004b0070e37bb5d0a50ae13d6626213fad91d3993f8aaa16f21e59b90d
+  data.tar.gz: 1f6984ef19e3db31035838f2b12b56cab7376d52ce7007f99e85b633a2868ad2
+SHA512:
+  metadata.gz: 49c02903a86f0e064d9bb5de90a91cbcd0ae41b1e69c54ac5fb88aa1e89ca13ad128e77589a4aa92f4a91bb739b060331945a6e37d2a49168a7790cefab638d8
+  data.tar.gz: ba5c4d1f8792d4125cc80dec1d1515b721b41d27aab465acb08f7565f5c4392a273ee304478f6c5e06d67973503282672c2815e6ec74021c91dcb39d07e70c21

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'webmock', '~> 1.22', '>= 1.22.6'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 khisakuni
+
+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,179 @@
+# Mopidy
+
+A lightweight wrapper around the Mopidy music server API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mopidy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mopidy
+
+## Usage
+
+The gem is divided into modules that reflect the controllers in the [Mopidy core API](https://docs.mopidy.com/en/latest/api/core).
+Currently, the supported modules are `Library`, `Playback`, `Playlist`, and `Tracklist`.
+
+### Configuration
+
+To configure the url that the gem makes requests to:
+```ruby
+Mopidy.configure do |config|
+  config.mopidy_url = 'http://localhost:6680/mopidy/rpc' # This is the default
+end
+```
+
+### Tracklist
+
+This is the module that interfaces with [Mopidy's tracklist controller](https://docs.mopidy.com/en/latest/api/core/#tracklist-controller)
+
+To get the tracks in the tracklist:
+```ruby
+Mopidy::Tracklist.tracks
+```
+
+To get the index of the currently playing track:
+```ruby
+Mopidy::Tracklist.index
+```
+
+To get the tracks in the tracklist as `TLTRack`s
+```ruby
+Mopidy::Tracklist.tl_tracks
+```
+
+To add a track to the tracklist:
+```ruby
+Mopidy::Tracklist.add(uri: 'example-track-uri')
+```
+
+To get the length of the tracklist:
+```ruby
+Mopidy::Tracklist.length
+```
+
+To clear the tracks from the tracklist:
+```ruby
+Mopidy::Tracklist.clear
+```
+
+### Library
+
+This is the module that interfaces with [Mopidy's Library controller](https://docs.mopidy.com/en/latest/api/core/#library-controller)
+
+To search for tracks, artists, playlists, and albums using a keyword:
+```ruby
+Mopidy::Library.search('queen')
+```
+
+To search for tracks by artist, album, or track:
+```ruby
+Mopidy::Library.search_tracks('bicycle')
+```
+
+To lookup a track by it's uri:
+
+```ruby
+Mopidy::Library.lookup('example-uri')
+```
+
+### Playlist
+
+This is the module that interfaces with [Mopidy's Playlist controller](https://docs.mopidy.com/en/latest/api/core/#playlist-controller)
+
+To get a list of playlists:
+```ruby
+Mopidy::Playlist.as_list
+```
+
+To lookup a playlist by it's uri
+```ruby
+Mopidy::Playlist.lookup('playlist-uri')
+```
+
+### Playback
+
+This is the module that interfaces with [Mopidy's Playback controller](https://docs.mopidy.com/en/latest/api/core/#playlist-controller)
+
+To play:
+```ruby
+Mopidy::Playback.play
+```
+
+To pause:
+```ruby
+Mopidy::Playback.pause
+```
+
+To resume:
+```ruby
+Mopidy::Playback.resume
+```
+
+To stop:
+```ruby
+Mopidy::Playback.stop
+```
+
+To get the playback state:
+```ruby
+Mopidy::Playback.state
+```
+
+To get the current time position:
+```ruby
+Mopidy::Playback.time_position
+```
+
+To seek to a time position:
+```ruby
+time_position = 1000 # Time position in milliseconds
+Mopidy::Playback.seek(time_position)
+```
+
+To get the currently playing track:
+```ruby
+Mopidy::Playback.current_track
+```
+
+To skip to the next track:
+```ruby
+Mopidy::Playback.next
+```
+
+### Mixer
+
+To get the current volume
+
+```
+Mopidy::Mixer.volume.body # => 100
+```
+
+To set the volume to 50
+```
+Mopidy::Mixer.volume(50)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/khisakuni/mopidy.
+
+
+## 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 "mopidy"
+
+# 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/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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

@@ -0,0 +1,45 @@
+require 'mopidy/version'
+require 'mopidy/library'
+require 'mopidy/playback'
+require 'mopidy/playlist'
+require 'mopidy/tracklist'
+require 'mopidy/mixer'
+require 'mopidy/response'
+require 'mopidy/http'
+require 'json'
+require 'httparty'
+
+module Mopidy
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :mopidy_url
+    attr_accessor :http_provider
+
+    def initialize
+      @mopidy_url = 'http://localhost:6680/mopidy/rpc'
+      @http_provider = HTTParty
+    end
+  end
+
+  def self.format_json(id, method, params = {})
+    {
+      'jsonrpc': '2.0',
+      'id': id,
+      'method': method,
+      'params': params
+    }.to_json
+  end
+
+  def self.post(body)
+    headers = { 'Content-Type' => 'application/json' }
+    res = Http.post(configuration.mopidy_url, body, headers)
+  end
+end

data/lib/mopidy/http.rb

@@ -0,0 +1,11 @@
+require 'mopidy/response'
+
+module Mopidy
+  class Http
+    def self.post(url, body, headers)
+      http_provider = Mopidy.configuration.http_provider
+      res = http_provider.post(url, body: body, headers: headers)
+      Response.new(res)
+    end
+  end
+end

data/lib/mopidy/library.rb

@@ -0,0 +1,36 @@
+require 'mopidy/response'
+
+module Mopidy
+  module Library
+    def self.search_tracks(keyword)
+      res = search(keyword)
+      tracks = parse_search_response(res, 'tracks')
+      format_response(tracks, res.status)
+    end
+
+    def self.lookup(uri)
+      json = Mopidy.format_json(1, 'core.library.lookup', 'uri': uri)
+      res = Mopidy.post(json)
+      res.body.empty? ? res : format_response(res.body.first, res.status)
+    end
+
+    def self.search(keyword)
+      json = Mopidy.format_json(1, 'core.library.search', [{ 'any': keyword }])
+      Mopidy.post(json)
+    end
+
+    private
+
+    def self.parse_search_response(response, type)
+      data = response.body.first[type]
+    end
+
+    def self.format_response(data, status_code)
+      new_response = OpenStruct.new(
+        parsed_response: { 'result' => data },
+        code: status_code
+      )
+      Mopidy::Response.new(new_response)
+    end
+  end
+end

data/lib/mopidy/mixer.rb

@@ -0,0 +1,13 @@
+module Mopidy
+  module Mixer
+    def self.volume
+      json = Mopidy.format_json(1, 'core.mixer.get_volume')
+      Mopidy.post(json)
+    end
+
+    def self.volume=(value)
+      json = Mopidy.format_json(1, 'core.mixer.set_volume', [value])
+      Mopidy.post(json)
+    end
+  end
+end

data/lib/mopidy/playback.rb

@@ -0,0 +1,50 @@
+module Mopidy
+  module Playback
+    def self.play(tracklist_track_id = nil)
+      params = { 'tlid': tracklist_track_id }
+      json = Mopidy.format_json(1, 'core.playback.play', params)
+      Mopidy.post(json)
+    end
+
+    def self.stop
+      json = Mopidy.format_json(1, 'core.playback.stop')
+      Mopidy.post(json)
+    end
+
+    def self.pause
+      json = Mopidy.format_json(1, 'core.playback.pause')
+      Mopidy.post(json)
+    end
+
+    def self.resume
+      json = Mopidy.format_json(1, 'core.playback.resume')
+      Mopidy.post(json)
+    end
+
+    def self.state
+      json = Mopidy.format_json(1, 'core.playback.get_state')
+      Mopidy.post(json)
+    end
+
+    def self.time_position
+      json = Mopidy.format_json(1, 'core.playback.get_time_position')
+      Mopidy.post(json)
+    end
+
+    def self.seek(time_position)
+      params = { 'time_position': time_position }
+      json = Mopidy.format_json(1, 'core.playback.seek', params)
+      Mopidy.post(json)
+    end
+
+    def self.current_track
+      json = Mopidy.format_json(1, 'core.playback.get_current_track')
+      Mopidy.post(json)
+    end
+
+    def self.next
+      json = Mopidy.format_json(1, 'core.playback.next')
+      Mopidy.post(json)
+    end
+  end
+end

data/lib/mopidy/playlist.rb

@@ -0,0 +1,18 @@
+module Mopidy
+  module Playlist
+    def self.as_list
+      json = Mopidy.format_json(1, 'core.playlists.as_list')
+      Mopidy.post(json)
+    end
+
+    def self.lookup(uri)
+      json = Mopidy.format_json(1, 'core.playlists.lookup', [uri])
+      Mopidy.post(json)
+    end
+
+    def self.save(playlist)
+      json = Mopidy.format_json(1, 'core.playlists.save', playlist: playlist)
+      Mopidy.post(json)
+    end
+  end
+end

data/lib/mopidy/response.rb

@@ -0,0 +1,29 @@
+module Mopidy
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def status
+      @response.code
+    end
+
+    def body
+      has_error?(@response) ? parse_error(@response) : parse_response(@response)
+    end
+
+    private
+
+    def has_error?(response)
+      response.parsed_response['result'].nil?
+    end
+
+    def parse_response(response)
+      response.parsed_response['result']
+    end
+
+    def parse_error(response)
+      response.parsed_response['error']
+    end
+  end
+end

data/lib/mopidy/tracklist.rb

@@ -0,0 +1,66 @@
+module Mopidy
+  module Tracklist
+    def self.load_playlist(playlist)
+      clear
+      playlist[:tracks].each do |track|
+        add(track)
+      end
+    end
+
+    def self.tracks
+      json = Mopidy.format_json(1, 'core.tracklist.get_tracks')
+      Mopidy.post(json)
+    end
+
+    def self.index
+      json = Mopidy.format_json(1, 'core.tracklist.index')
+      Mopidy.post(json)
+    end
+
+    def self.shuffle(start_index, end_index)
+      params = { 'start': start_index, 'end': end_index }
+      json = Mopidy.format_json(1, 'core.tracklist.shuffle', params)
+      Mopidy.post(json)
+    end
+
+    def self.tl_tracks
+      json = Mopidy.format_json(1, 'core.tracklist.get_tl_tracks')
+      Mopidy.post(json)
+    end
+
+    def self.add(track)
+      json = Mopidy.format_json(1, 'core.tracklist.add', 'uris': [track[:uri]])
+      Mopidy.post(json)
+    end
+
+    def self.length
+      json = Mopidy.format_json(1, 'core.tracklist.get_length')
+      Mopidy.post(json)
+    end
+
+    def self.clear
+      json = Mopidy.format_json(1, 'core.tracklist.clear')
+      Mopidy.post(json)
+    end
+
+    def self.repeat
+      json = Mopidy.format_json(1, 'core.tracklist.get_repeat')
+      Mopidy.post(json)
+    end
+
+    def self.repeat=(value)
+      json = Mopidy.format_json(1, 'core.tracklist.set_repeat', [!!value])
+      Mopidy.post(json)
+    end
+
+    def self.single
+      json = Mopidy.format_json(1, 'core.tracklist.get_single')
+      Mopidy.post(json)
+    end
+
+    def self.single=(value)
+      json = Mopidy.format_json(1, 'core.tracklist.set_single', [!!value])
+      Mopidy.post(json)
+    end
+  end
+end

data/lib/mopidy/version.rb

@@ -0,0 +1,3 @@
+module Mopidy
+  VERSION = "0.2.1"
+end

data/mopidy.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mopidy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-mopidy'
+  spec.version       = Mopidy::VERSION
+  spec.authors       = ['khisakuni', 'ares']
+  spec.email         = ['kohei@gophilosophie.com', 'ares@igloonet.com']
+
+  spec.summary       = 'A wrapper around the Mopidy API.'
+  spec.homepage      = 'https://github.com/ares/mopidy'
+  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_dependency 'httparty'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ruby-mopidy
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- khisakuni
+- ares
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  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: pry
+  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'
+description:
+email:
+- kohei@gophilosophie.com
+- ares@igloonet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/mopidy.rb
+- lib/mopidy/http.rb
+- lib/mopidy/library.rb
+- lib/mopidy/mixer.rb
+- lib/mopidy/playback.rb
+- lib/mopidy/playlist.rb
+- lib/mopidy/response.rb
+- lib/mopidy/tracklist.rb
+- lib/mopidy/version.rb
+- mopidy.gemspec
+homepage: https://github.com/ares/mopidy
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A wrapper around the Mopidy API.
+test_files: []