wimp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33f696af3b35c37758582a083c1819ca8018bd5e
+  data.tar.gz: 9900a5d12eb6860e89ee257c2e4a4d12caf158a8
+SHA512:
+  metadata.gz: e31aac6e779ded4353db920af4090919028bb891ce7317730d11fe4dd898501b3f37d2e2ce23f7633c3a06c0cc06573f5602bcaf8d8d1071bdba8e4ed1c7daf6
+  data.tar.gz: 37183d695c5193fe32f57d108c7967c4242c0da55d95dd01b8edc188062700667e83c3beb3e633500ea59cbe0d204373405253adb245bc18f65648a8839c166f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rake_tasks~

data/.rspec

@@ -0,0 +1,5 @@
+--color
+-fs
+-Ilib
+-Ispec
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Linus Oleander
+
+MIT License
+
+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,154 @@
+# WiMP
+
+Ruby bindings for [WiMP](http://wimpmusic.com). The library uses WiMPs 
+internal RPC API. Take a look at the [FAQ](#faq) for frequently asked 
+questions and how to port this library to any language using 
+[thrift](http://thrift.apache.org/).
+
+## Installation
+
+```
+$ gem install wimp
+```
+
+## Usage
+
+Keep in mind that you need premium acount for this to work.
+
+``` ruby
+WiMP.configure do |config|
+  config.username = "email@example.com"
+  config.password = "my-password"
+end
+```
+
+### WiMP::Track
+
+#### Search
+
+``` ruby
+tracks = WiMP::Track.search(query, {
+  limit: 10
+})
+```
+
+### WiMP::Playlist
+
+Note that you can only read and update your own playlists, 
+not someone else's.
+
+#### Find a playlist
+
+``` ruby
+playlist = WiMP::Playlist.find(uuid)
+```
+
+#### Create a playlist
+
+``` ruby
+playlist = WiMP::Playlist.create(title)
+```
+
+#### Add tracks to playlist
+
+``` ruby
+status = playlist.add_tracks(tracks, {
+  start_position: 1
+})
+```
+
+#### Add tracks to playlist using Track#id
+
+``` ruby
+status = playlist.add_tracks_by_id(track_ids, {
+  start_position: 1
+})
+```
+
+#### Remove tracks from playlist
+
+``` ruby
+status = playlist.remove_tracks_by_indices(tracks)
+```
+
+## Containers
+
+### WiMP::Track
+
+- title **String**
+- album_id **Integer**
+- duration **Integer**
+- id **Integer**
+- popularity **Integer**
+- artist **WiMP::SimpleArtist**
+- url **String**
+
+### WiMP::Playlist
+
+- count **Integer**
+- url **String**
+- tracks **Array< WiMP::Track >**
+- uuid **String**
+- id **Integer**
+
+### WiMP::SimpleArtist
+
+- id **Integer**
+- name **String**
+- url **String**
+
+## FAQ
+
+### Can I port this library to language X?
+
+Probably. WiMP uses [thrift](http://thrift.apache.org/) behind the scene, 
+which means that code for C++, C#, Erlang, Haskell, Java, Objective 
+C/Cocoa, OCaml, Perl, PHP, Python, and Squeak can be generated. Take a look 
+at the `resources/thrift` folder and the `Rakefile` file for more 
+information on how this could be done.
+
+[Here is a good thrift tutorial](http://diwakergupta.github.io/thrift-missing-guide/) 
+that explains the basics.
+
+### Can I stream music using this library?
+
+The WiMP API has support for streaming, but I've chosen not to include 
+those methods.
+
+### Where is the rest of the implementation?
+
+Take a look at the `lib/gen` folder for more, undocumented code. Code
+exists for all 50 some methods in the thirft directory, but only a few are
+ported to a Ruby-friendly syntax and documented above. You're more than
+welcome to help me migrate all these methods.
+
+Some methods from the offical API isn't ported to thrift. You'll find a list
+of these in the `resources/skipped-methods.md` file.
+
+### I'm get an `Thrift::ApplicationException` error
+
+The `Thrift::ApplicationException` error indicates that the returning data
+from WiMP isn't what we think it is. It's usually caused by invalid data being passed
+to thrift. 
+
+In other words; check the data being passed from this library. Is it correct?
+
+## Notes
+
+1. Not all methods existing in the offical API are documented above, but 
+the code for all of them exists. Navigate the `lib` folder for more information.
+2. The first request to the API will be slower than the rest.
+That's because a session is created.
+3. None of the credentials in this project are my own. They're 
+only created to be used in the specs. They might therefore already 
+be expired when you read this.
+4. This library has been created for educational purposes. You shouldn't
+use it without first consulting WiMP.
+
+## Contributing
+
+1. Fork it ( http://github.com/oleander/wimp-api-rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc "Regenerates classes using thrift"
+task :thrift do
+  puts `thrift --gen rb -out lib/gen -v resources/thrift/services.thrift`
+end

data/lib/gen/README.md

@@ -0,0 +1,6 @@
+# Thrift Compiler info
+
+This code is autogenerated by the Thrift Compiler.
+Do not edit this code. You should instead edit the
+thrift files in `resources/thrift`. To update your 
+changes run `rake thrift` in the home folder of this project.

data/lib/gen/client_api_login_service.rb

@@ -0,0 +1,270 @@
+#
+# Autogenerated by Thrift Compiler (0.9.1)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'services_types'
+
+module WiMP
+  module Gen
+    module ClientApiLoginService
+      class Client
+        include ::Thrift::Client
+
+        def getClientConfig(partnerUsername, partnerPassword, clientName)
+          send_getClientConfig(partnerUsername, partnerPassword, clientName)
+          return recv_getClientConfig()
+        end
+
+        def send_getClientConfig(partnerUsername, partnerPassword, clientName)
+          send_message('getClientConfig', GetClientConfig_args, :partnerUsername => partnerUsername, :partnerPassword => partnerPassword, :clientName => clientName)
+        end
+
+        def recv_getClientConfig()
+          result = receive_message(GetClientConfig_result)
+          return result.success unless result.success.nil?
+          raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'getClientConfig failed: unknown result')
+        end
+
+        def simpleLogin(userName, password, partnerUsername, partnerPassword, clientName, clientUniqueKey)
+          send_simpleLogin(userName, password, partnerUsername, partnerPassword, clientName, clientUniqueKey)
+          return recv_simpleLogin()
+        end
+
+        def send_simpleLogin(userName, password, partnerUsername, partnerPassword, clientName, clientUniqueKey)
+          send_message('simpleLogin', SimpleLogin_args, :userName => userName, :password => password, :partnerUsername => partnerUsername, :partnerPassword => partnerPassword, :clientName => clientName, :clientUniqueKey => clientUniqueKey)
+        end
+
+        def recv_simpleLogin()
+          result = receive_message(SimpleLogin_result)
+          return result.success unless result.success.nil?
+          raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'simpleLogin failed: unknown result')
+        end
+
+        def recoverPassword(userName, partnerUsername, partnerPassword)
+          send_recoverPassword(userName, partnerUsername, partnerPassword)
+          return recv_recoverPassword()
+        end
+
+        def send_recoverPassword(userName, partnerUsername, partnerPassword)
+          send_message('recoverPassword', RecoverPassword_args, :userName => userName, :partnerUsername => partnerUsername, :partnerPassword => partnerPassword)
+        end
+
+        def recv_recoverPassword()
+          result = receive_message(RecoverPassword_result)
+          return result.success unless result.success.nil?
+          raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'recoverPassword failed: unknown result')
+        end
+
+        def loginWithToken(userName, password, partnerUsername, partnerPassword, clientName)
+          send_loginWithToken(userName, password, partnerUsername, partnerPassword, clientName)
+          return recv_loginWithToken()
+        end
+
+        def send_loginWithToken(userName, password, partnerUsername, partnerPassword, clientName)
+          send_message('loginWithToken', LoginWithToken_args, :userName => userName, :password => password, :partnerUsername => partnerUsername, :partnerPassword => partnerPassword, :clientName => clientName)
+        end
+
+        def recv_loginWithToken()
+          result = receive_message(LoginWithToken_result)
+          return result.success unless result.success.nil?
+          raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'loginWithToken failed: unknown result')
+        end
+
+      end
+
+      class Processor
+        include ::Thrift::Processor
+
+        def process_getClientConfig(seqid, iprot, oprot)
+          args = read_args(iprot, GetClientConfig_args)
+          result = GetClientConfig_result.new()
+          result.success = @handler.getClientConfig(args.partnerUsername, args.partnerPassword, args.clientName)
+          write_result(result, oprot, 'getClientConfig', seqid)
+        end
+
+        def process_simpleLogin(seqid, iprot, oprot)
+          args = read_args(iprot, SimpleLogin_args)
+          result = SimpleLogin_result.new()
+          result.success = @handler.simpleLogin(args.userName, args.password, args.partnerUsername, args.partnerPassword, args.clientName, args.clientUniqueKey)
+          write_result(result, oprot, 'simpleLogin', seqid)
+        end
+
+        def process_recoverPassword(seqid, iprot, oprot)
+          args = read_args(iprot, RecoverPassword_args)
+          result = RecoverPassword_result.new()
+          result.success = @handler.recoverPassword(args.userName, args.partnerUsername, args.partnerPassword)
+          write_result(result, oprot, 'recoverPassword', seqid)
+        end
+
+        def process_loginWithToken(seqid, iprot, oprot)
+          args = read_args(iprot, LoginWithToken_args)
+          result = LoginWithToken_result.new()
+          result.success = @handler.loginWithToken(args.userName, args.password, args.partnerUsername, args.partnerPassword, args.clientName)
+          write_result(result, oprot, 'loginWithToken', seqid)
+        end
+
+      end
+
+      # HELPER FUNCTIONS AND STRUCTURES
+
+      class GetClientConfig_args
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        PARTNERUSERNAME = 1
+        PARTNERPASSWORD = 2
+        CLIENTNAME = 3
+
+        FIELDS = {
+          PARTNERUSERNAME => {:type => ::Thrift::Types::STRING, :name => 'partnerUsername'},
+          PARTNERPASSWORD => {:type => ::Thrift::Types::STRING, :name => 'partnerPassword'},
+          CLIENTNAME => {:type => ::Thrift::Types::STRING, :name => 'clientName'}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class GetClientConfig_result
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        SUCCESS = 0
+
+        FIELDS = {
+          SUCCESS => {:type => ::Thrift::Types::MAP, :name => 'success', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRING}}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class SimpleLogin_args
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        USERNAME = 1
+        PASSWORD = 2
+        PARTNERUSERNAME = 3
+        PARTNERPASSWORD = 4
+        CLIENTNAME = 5
+        CLIENTUNIQUEKEY = 6
+
+        FIELDS = {
+          USERNAME => {:type => ::Thrift::Types::STRING, :name => 'userName'},
+          PASSWORD => {:type => ::Thrift::Types::STRING, :name => 'password'},
+          PARTNERUSERNAME => {:type => ::Thrift::Types::STRING, :name => 'partnerUsername'},
+          PARTNERPASSWORD => {:type => ::Thrift::Types::STRING, :name => 'partnerPassword'},
+          CLIENTNAME => {:type => ::Thrift::Types::STRING, :name => 'clientName'},
+          CLIENTUNIQUEKEY => {:type => ::Thrift::Types::STRING, :name => 'clientUniqueKey'}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class SimpleLogin_result
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        SUCCESS = 0
+
+        FIELDS = {
+          SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ::WiMP::Gen::Profile}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class RecoverPassword_args
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        USERNAME = 1
+        PARTNERUSERNAME = 2
+        PARTNERPASSWORD = 3
+
+        FIELDS = {
+          USERNAME => {:type => ::Thrift::Types::STRING, :name => 'userName'},
+          PARTNERUSERNAME => {:type => ::Thrift::Types::STRING, :name => 'partnerUsername'},
+          PARTNERPASSWORD => {:type => ::Thrift::Types::STRING, :name => 'partnerPassword'}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class RecoverPassword_result
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        SUCCESS = 0
+
+        FIELDS = {
+          SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ::WiMP::Gen::Profile}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class LoginWithToken_args
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        USERNAME = 1
+        PASSWORD = 2
+        PARTNERUSERNAME = 3
+        PARTNERPASSWORD = 4
+        CLIENTNAME = 5
+
+        FIELDS = {
+          USERNAME => {:type => ::Thrift::Types::STRING, :name => 'userName'},
+          PASSWORD => {:type => ::Thrift::Types::STRING, :name => 'password'},
+          PARTNERUSERNAME => {:type => ::Thrift::Types::STRING, :name => 'partnerUsername'},
+          PARTNERPASSWORD => {:type => ::Thrift::Types::STRING, :name => 'partnerPassword'},
+          CLIENTNAME => {:type => ::Thrift::Types::STRING, :name => 'clientName'}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class LoginWithToken_result
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        SUCCESS = 0
+
+        FIELDS = {
+          SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ::WiMP::Gen::Profile}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+    end
+
+  end
+end