shoutcast-api-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 047b193a31dcd4eefe97edc0a15b9a46b93d249f
+  data.tar.gz: f86bd2588fb027bc6f521ee849c5fe76d6bd5923
+SHA512:
+  metadata.gz: da627a4b652f19fc276c5a382303fd38ecec1816746a9187f7c54130f0ba836b29d35d02a023c65b68b9ee746e69ab3b0fcacefc4a62221af3e700b942584829
+  data.tar.gz: e6b65f76c9631c4deafed6f8ce99c606bdda7d1145c8a69fdd042bafad65a9578dce29149f014f6b08d1d6046c384d60e8f93b4a383e7cf55e5777f813770105

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+Unreleased ([Changelog](https://github.com/colszowka/simplecov/compare/v0.0.1...master))
+==========
+## Features
+
+## Enhancements
+
+## Bugfixes
+
+0.0.1 ([Changelog](https://github.com/marcferna/shoutcast-api-client/compare/25b8f34...v0.0.1))
+=================
+## Features
+
+* Added Top 500 API interface.
+* Stations XML Parsing into Ruby objects.

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+## Reporting Issues
+
+You can report issues at https://github.com/marcferna/shoutcast-api-client/issues
+
+Before submitting a new issue, search to see if someone else already reported it.
+If that is not the case and you create a new issue, please include:
+* Version of the `shoutcast-api-client` you are running.
+* Full backtrace of the issue if applicable.
+* Sample code if possible.
+
+Thanks!
+
+## Making Contributions
+
+If you want to contribute, please:
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add specs for it.
+  * Make sure to run `rubocop` and that there are no complaints/warnings.
+  * Update the `CHANGELOG.md` if applicable.
+  * Send me a pull request on Github.
+
+Thanks!

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marc Fernandez
+
+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,60 @@
+# SHOUTcast API Client
+[![Build Status](https://travis-ci.org/marcferna/shoutcast-api-client.svg?branch=master)](https://travis-ci.org/marcferna/shoutcast-api-client) [![Code Climate](https://codeclimate.com/github/marcferna/shoutcast-api-client/badges/gpa.svg)](https://codeclimate.com/github/marcferna/shoutcast-api-client) [![Test Coverage](https://codeclimate.com/github/marcferna/shoutcast-api-client/badges/coverage.svg)](https://codeclimate.com/github/marcferna/shoutcast-api-client/coverage) [![Dependency Status](https://gemnasium.com/badges/github.com/marcferna/shoutcast-api-client.svg)](https://gemnasium.com/github.com/marcferna/shoutcast-api-client)
+
+:exclamation:**Important - You will need a SHOUTcast API key for this gem to work. You can request one from their [developer website](https://www.shoutcast.com/Developer)**
+
+:warning:  *Note - This gem is an early alpha and is still in development. Use at your own risk.*  :warning:
+
+## Description
+This gem provides a nice interface to interact with SHOUTcast’s API and also parses the XML response into Ruby objects.
+You can find the full API documentation in [SHOUTcast’s official documentation page](http://wiki.winamp.com/wiki/SHOUTcast_Radio_Directory_API).
+
+## Progress
+This gem is an early alpha and is still in development. To see a more detailed
+progress description you can check the [CHANGELOG.md](CHANGELOG.md)
+
+### Stations
+
+- [x] Top 500 (Passing parameters not implemented yet)
+- [ ] Keyword Search
+- [ ] Stations by Genre
+- [ ] Stations by Now Playing Info
+- [ ] Stations by Bitrate or Codec Type or Genre ID
+- [ ] Random Stations
+
+### Genres
+
+- [ ] All Genres
+- [ ] Primary Genres
+- [ ] Secondary Genres
+- [ ] Genres Details by Passing Genreid
+- [ ] Genres Based on Availability of Sub-Genres
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'shoutcast-api-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shoutcast-api-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+## 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 'shoutcast/api'
+
+# 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/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/shoutcast/api.rb

@@ -0,0 +1,8 @@
+require 'shoutcast/api/version'
+require 'shoutcast/api/client'
+require 'shoutcast/api/station'
+
+module Shoutcast
+  module Api
+  end
+end

data/lib/shoutcast/api/client.rb

@@ -0,0 +1,31 @@
+module Shoutcast
+  module Api
+    class Client
+      require 'rest-client'
+      require 'nori'
+
+      def initialize(key:)
+        @key = key
+      end
+
+      def top_500
+        response = RestClient.get url('/legacy/Top500')
+        Nori.new.parse(response)['stationlist']['station'].map do |attributes|
+          Shoutcast::Api::Station.parse(attributes)
+        end
+      end
+
+      private
+
+      attr_accessor :key
+
+      def base_url
+        'http://api.shoutcast.com'
+      end
+
+      def url(path)
+        "#{base_url}#{path}?k=#{key}"
+      end
+    end
+  end
+end

data/lib/shoutcast/api/station.rb

@@ -0,0 +1,39 @@
+module Shoutcast
+  module Api
+    class Station
+      attr_accessor :id, :name, :mt, :br, :genres, :ct, :lc, :logo
+      alias media_type mt
+      alias bitrate br
+      alias current_track ct
+
+      class << self
+        def parse(attributes)
+          station        = new
+          station.id     = attributes['@id']
+          station.name   = attributes['@name']
+          station.mt     = attributes['@mt']
+          station.br     = attributes['@br']
+          station.genres = parse_genres(attributes)
+          station.ct     = attributes['@ct']
+          station.lc     = attributes['@lc']
+          station.logo   = attributes['@logo']
+          station
+        end
+
+        private
+
+        def parse_genres(attributes)
+          genres = []
+          current_genre = attributes['@genre']
+          genre_index = 1
+          until current_genre.nil?
+            genres << current_genre
+            genre_index += 1
+            current_genre = attributes["@genre#{genre_index}"]
+          end
+          genres
+        end
+      end
+    end
+  end
+end

data/lib/shoutcast/api/version.rb

@@ -0,0 +1,5 @@
+module Shoutcast
+  module Api
+    VERSION = '0.0.1'.freeze
+  end
+end

data/shoutcast-api-client.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shoutcast/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shoutcast-api-client'
+  spec.version       = Shoutcast::Api::VERSION
+  spec.authors       = ['Marc Fernandez']
+  spec.email         = ['marc.fernandezg@gmail.com']
+
+  spec.summary       = 'SHOUTcast API wrapper.'
+  spec.description   = 'Wrapper for the SHOUTcast API.'
+  spec.homepage      = 'https://github.com/marcferna/shoutcast-api-client'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem '\
+      'pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 'rest-client', '~> 2.0'
+  spec.add_dependency 'nori', '~> 2.6'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.42'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-json'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: shoutcast-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marc Fernandez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-json
+  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: codeclimate-test-reporter
+  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: Wrapper for the SHOUTcast API.
+email:
+- marc.fernandezg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shoutcast/api.rb
+- lib/shoutcast/api/client.rb
+- lib/shoutcast/api/station.rb
+- lib/shoutcast/api/version.rb
+- shoutcast-api-client.gemspec
+homepage: https://github.com/marcferna/shoutcast-api-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: SHOUTcast API wrapper.
+test_files: []