mopidy 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 081da1b64b16da1f6880b35e4eb208fa8d7fd400
-  data.tar.gz: 6f76451a4df365c8bb1f9413e8e3106b1be7a32a
+  metadata.gz: eeb054524f44a01b1636a160fefaf37a2f1f3e98
+  data.tar.gz: c3b32bfbd837e4866e71ccacecbb5580bdb99414
 SHA512:
-  metadata.gz: b31801cacd9ffbe42cddd7a4fa3344d861d6256085f6a513296a27e65501076f776b71bee2cf4e83dd3236e0f366becafaa2b8f4d81035ce1058ea7c0557ea8a
-  data.tar.gz: 96b8af968719bf5ee949a9389beae50e6905a7d21234ccbe06c2f1b6f262439857bbace552d2fdb0f79c6a25df2acc2424e684428f86dfe461e5ec8a45ebc82c
+  metadata.gz: 160c377c501b708c2d2ee35459f8880a6b872e78dfba95a78f820a966e8638712947de3446742f69d0be0f3bcd1c7018a0b60721b9b15e194ee37d3c2db148c4
+  data.tar.gz: 286faf4452ee45b1355c735198b5cbcd6a862137a5623f183c6d82dc1d44df8a55004f21518dd6e729871413824fef54533c5a7307c7664b765927a314984eb5

data/README.md

@@ -1,8 +1,6 @@
 # Mopidy
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mopidy`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A lightweight wrapper around the Mopidy music server API.
 
 ## Installation
 
@@ -22,7 +20,135 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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::Playlist.play
+```
+
+To pause:
+```ruby
+Mopidy::Playlist.pause
+```
+
+To resume:
+```ruby
+Mopidy::Playlist.resume
+```
+
+To stop:
+```ruby
+Mopidy::Playlist.stop
+```
+
+To get the playback state:
+```ruby
+Mopidy::Playlist.state
+```
+
+To get the current time position:
+```ruby
+Mopidy::Playlist.time_position
+```
+
+To seek to a time position:
+```ruby
+time_position = 1000 # Time position in milliseconds
+Mopidy::Playlist.seek(time_position)
+```
+
+To get the currently playing track:
+```ruby
+Mopidy::Playlist.current_track
+```
+
+To skip to the next track:
+```ruby
+Mopidy::Playlist.next
+```
 
 ## Development
 
@@ -32,10 +158,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mopidy.
+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/lib/mopidy.rb

@@ -3,6 +3,8 @@ require 'mopidy/library'
 require 'mopidy/playback'
 require 'mopidy/playlist'
 require 'mopidy/tracklist'
+require 'mopidy/response'
+require 'mopidy/http'
 require 'json'
 require 'httparty'
 
@@ -18,9 +20,11 @@ module Mopidy
 
   class Configuration
     attr_accessor :mopidy_url
+    attr_accessor :http_provider
 
     def initialize
-      @mopidy_url ||= 'http://localhost:6680/mopidy/rpc'
+      @mopidy_url = 'http://localhost:6680/mopidy/rpc'
+      @http_provider = HTTParty
     end
   end
 
@@ -34,15 +38,7 @@ module Mopidy
   end
 
   def self.post(body)
-    post = HTTParty.post(
-      configuration.mopidy_url,
-      body: body,
-      headers: {
-        'Content-Type' => 'application/json'
-      }
-    )
-    result = post.parsed_response['result']
-    return {} if result.nil?
-    result
+    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

@@ -1,28 +1,36 @@
+require 'mopidy/response'
+
 module Mopidy
   module Library
     def self.search_tracks(keyword)
-      results = search(keyword)
-      return [] if results.nil?
-      results['tracks']
+      res = search(keyword)
+      tracks = parse_search_response(res, 'tracks')
+      format_response(tracks, res.status)
     end
 
-    def self.get_track(uri)
+    def self.lookup(uri)
       json = Mopidy.format_json(1, 'core.library.lookup', 'uri': uri)
-      response = Mopidy.post(json)
-      return response.first unless response.empty?
-      {}
+      res = Mopidy.post(json)
+      res.body.empty? ? res : format_response(res.body.first, res.status)
     end
 
-    private
-
     def self.search(keyword)
       json = Mopidy.format_json(1, 'core.library.search', [{ 'any': keyword }])
-      Mopidy.post(json).first
+      Mopidy.post(json)
+    end
+
+    private
+
+    def self.parse_search_response(response, type)
+      data = response.body.first[type]
     end
 
-    def self.parse_search_response(response)
-      result = response.parsed_response['result']
-      result.first unless result.nil?
+    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/playlist.rb

@@ -5,12 +5,12 @@ module Mopidy
       Mopidy.post(json)
     end
 
-    def self.playlist(uri)
+    def self.lookup(uri)
       json = Mopidy.format_json(1, 'core.playlists.lookup', [uri])
       Mopidy.post(json)
     end
 
-    def self.save_playlist(playlist)
+    def self.save(playlist)
       json = Mopidy.format_json(1, 'core.playlists.save', playlist: playlist)
       Mopidy.post(json)
     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

@@ -7,7 +7,7 @@ module Mopidy
       end
     end
 
-    def self.tracklist
+    def self.tracks
       json = Mopidy.format_json(1, 'core.tracklist.get_tracks')
       Mopidy.post(json)
     end
@@ -23,7 +23,7 @@ module Mopidy
       Mopidy.post(json)
     end
 
-    def self.tracks
+    def self.tl_tracks
       json = Mopidy.format_json(1, 'core.tracklist.get_tl_tracks')
       Mopidy.post(json)
     end

data/lib/mopidy/version.rb

@@ -1,3 +1,3 @@
 module Mopidy
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mopidy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - khisakuni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -98,9 +98,11 @@ files:
 - bin/rspec
 - bin/setup
 - lib/mopidy.rb
+- lib/mopidy/http.rb
 - lib/mopidy/library.rb
 - lib/mopidy/playback.rb
 - lib/mopidy/playlist.rb
+- lib/mopidy/response.rb
 - lib/mopidy/tracklist.rb
 - lib/mopidy/version.rb
 - mopidy.gemspec
@@ -124,8 +126,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A wrapper around the Mopidy API.
 test_files: []
+has_rdoc: