dirble 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0df8ae2244e7353f53e1dbf4a22458fc928a2eed
+  data.tar.gz: e39e36b0dba25becdc8734376011e7dc1791f5dd
+SHA512:
+  metadata.gz: fc4d75608532f9b29290a6d9b8717cdacfb078e3c02ecfe23d671e232f863813e10b18675a66df560d4183fd2a9b717a87241e704b7418d106dbaace13080eb0
+  data.tar.gz: 76643a5a4a09deb653fdaacded4ee8f611e7d7a04e83a36c490d2a247238cd6495e61833e3c61e59196e02c7fbc331bea6e65cfae021c60a16dc18cf013918fe

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+dirble

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.1.5"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx
+script: rake spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Przemek Mroczek
+
+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,94 @@
+[![Code Climate](https://codeclimate.com/github/Lackoftactics/dirble/badges/gpa.svg)](https://codeclimate.com/github/Lackoftactics/dirble)
+[![Build Status](https://travis-ci.org/Lackoftactics/dirble.svg?branch=master)](https://travis-ci.org/Lackoftactics/dirble)
+[![Coverage Status](https://coveralls.io/repos/Lackoftactics/dirble/badge.png?branch=master)](https://coveralls.io/r/Lackoftactics/dirble?branch=master)
+# Dirble
+
+Gem to make interacting with http://api.dirble.com/ amazingly easy.
+Using familiar Rails syntax. It uses Faraday and Typhoeus as adapter.
+
+## Compatibility
+
+* Ruby 1.9.3 and 2
+* JRuby 1.7
+* Rubinius
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dirble'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dirble
+
+## Usage
+
+In Rails: Put this quick configuration block in environment file.
+Beyond Rails: Put this in initialization or config file.
+```ruby
+Dirble.configure do |config|
+  config.api_key = "valid_api_key_from_dirble"
+end
+```
+Now you are ready to go.
+## Category
+* Fetch all categories with
+
+  `Dirble::Category.all`
+
+* Fetch primary categories with
+
+  `Dirble::Category.primary` or
+  `Dirble::PrimaryCategory.all`
+
+* Find category by id
+
+  `Dirble::Category.find(2)`
+
+* Get first category
+
+  `Dirble::Category.first`
+
+* Find children of primary category
+
+```ruby
+  primary_category = Dirble::PrimaryCategory.first
+  children = primary_category.children
+```
+
+* Find stations of category
+
+  `category.stations`
+
+## Station
+
+* Search stations
+
+  `Dirble::Station.search('pop')`
+
+* Stations by continent
+
+  `Dirble::Station.by_continent('Asia')`
+
+* Stations by country
+
+  `Dirble::Station.by_country('us')`
+
+* Stations amount. Check currently registered stations in Dirble.
+
+  `Dirble::Station.count`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dirble/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+

data/dirble.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dirble/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dirble"
+  spec.version       = Dirble::VERSION
+  spec.authors       = ["Przemek Mroczek"]
+  spec.email         = ["przemyslawmroczek@o2.pl"]
+  spec.summary       = %q{Gem for easier interacting with dirble api.}
+  spec.description   = %q{Api wrapper for easier using dirble api.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry-rescue"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "sinatra-contrib"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "typhoeus"
+  spec.add_development_dependency "coveralls"
+end

data/lib/dirble.rb

@@ -0,0 +1,16 @@
+require 'active_support/all'
+require 'dirble/simple_api_model'
+require 'dirble/errors'
+require 'dirble/configurable'
+require 'dirble/connection'
+require 'dirble/category'
+require 'dirble/primary_category'
+require 'dirble/station'
+
+require 'dirble/version'
+
+module Dirble
+  class << self
+    include Dirble::Configurable
+  end
+end

data/lib/dirble/category.rb

@@ -0,0 +1,48 @@
+module Dirble
+  class Category
+    extend Dirble::SimpleApiModel
+
+    attr_accessor :id, :name, :description
+
+    def initialize(options)
+      self.id = options[:id]
+      self.name = options[:name]
+      self.description = options[:description]
+    end
+
+    def self.all
+      call_api_with_results(
+        request_type: :get,
+        query: 'categories/apikey/{{api_key}}'
+      )
+    end
+
+    def self.find(category_id)
+      all.select { |category| category.id == category_id }.first
+    end
+
+    def self.first
+      all.first
+    end
+
+    def self.primary
+      call_api_with_results(
+        request_type: :get,
+        query: 'primaryCategories/apikey/{{api_key}}',
+        factory_klass: Dirble::PrimaryCategory
+      )
+    end
+
+    def stations
+      self.class.call_api_with_results(
+        request_type: :get,
+        query: "stations/apikey/{{api_key}}/id/#{id}",
+        factory_klass: Dirble::Station
+      )
+    end
+
+    def primary
+      false
+    end
+  end
+end

data/lib/dirble/configurable.rb

@@ -0,0 +1,20 @@
+module Dirble
+  module Configurable
+    attr_accessor :api_key, :connection
+
+    def configure
+      yield self
+      prepare_connection
+      self
+    end
+
+    def prepare_connection
+      raise ArgumentError, 'You have to set api key in configure' unless self.api_key
+      self.connection = Dirble::Connection.new
+    end
+
+    def reset!
+      self.api_key = nil
+    end
+  end
+end

data/lib/dirble/connection.rb

@@ -0,0 +1,25 @@
+require_relative 'query_executer'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+module Dirble
+  class Connection
+    DIRBLE_API_URL = 'http://api.dirble.com/v1'
+
+    def exec_query(query_params)
+      QueryExecuter.new(connection, query_params).execute
+    end
+
+    private
+
+    def connection
+      @connection ||= begin
+                        Faraday.new(url: DIRBLE_API_URL) do |faraday|
+                          faraday.request :url_encoded
+                          faraday.response :logger
+                          faraday.adapter :typhoeus
+                        end
+                      end
+    end
+  end
+end

data/lib/dirble/errors.rb

@@ -0,0 +1,5 @@
+module Dirble
+  module Errors
+    class InvalidRequestType < StandardError; end
+  end
+end

data/lib/dirble/primary_category.rb

@@ -0,0 +1,20 @@
+module Dirble
+  class PrimaryCategory < Category
+
+    def self.all
+      Dirble::Category.primary
+    end
+
+    def children
+      self.class.call_api_with_results(
+        request_type: :get,
+        query: "childCategories/apikey/{{api_key}}/primaryid/#{id}",
+        factory_klass: Dirble::Category
+      )
+    end
+
+    def primary
+      true
+    end
+  end
+end

data/lib/dirble/query_executer.rb

@@ -0,0 +1,34 @@
+module Dirble
+  class QueryExecuter
+    REQUEST_TYPES = [:get, :post, :put, :delete, :patch]
+
+    def initialize(connection, query_params)
+      self.connection = connection
+      self.request_type = query_params[:request_type]
+      self.query = query_params[:query]
+      self.form_fields = query_params[:form_fields]
+    end
+
+    def execute
+      guard_query_params
+      replace_placeholder_with_api_key
+      if form_fields
+        connection.send(request_type, query, form_fields)
+      else
+        connection.send(request_type, query)
+      end
+    end
+
+    private
+
+    attr_accessor :connection, :request_type, :query, :form_fields
+
+    def guard_query_params
+      raise Dirble::Errors::InvalidRequestType, 'Bad request type provided. Please use :get or :post' unless REQUEST_TYPES.include?(request_type)
+    end
+
+    def replace_placeholder_with_api_key
+      query.gsub!("{{api_key}}", Dirble.api_key)
+    end
+  end
+end

data/lib/dirble/simple_api_model.rb

@@ -0,0 +1,19 @@
+module Dirble
+  module SimpleApiModel
+    def call_api_with_results(options)
+      factory_klass = options.delete(:factory_klass) || self
+      response = Dirble.connection.exec_query(options).body
+      build_from_api_response(factory_klass, response)
+    end
+
+    def build_from_api_response(target_class, response)
+      parsed_collection(response).each_with_object([]) do |object_params, collection|
+        collection << target_class.new(object_params.with_indifferent_access)
+      end
+    end
+
+    def parsed_collection(json_response)
+      Array.wrap(JSON.parse(json_response))
+    end
+  end
+end

data/lib/dirble/song.rb

@@ -0,0 +1,8 @@
+module Dirble
+  class Song
+    attr_accessor :id, :image_url, :name, :title, :spotify_url, :played_on
+
+    def initialize(args)
+    end
+  end
+end

data/lib/dirble/station.rb

@@ -0,0 +1,72 @@
+module Dirble
+  class Station
+    REQUIRED_FIELDS = [:name, :website, :directory]
+
+    extend Dirble::SimpleApiModel
+
+    attr_accessor :id, :name, :stream_url, :description, :website, :url_id,
+      :song_history, :categories, :country, :bitrate, :status
+
+    def initialize(options)
+      self.id = options[:id]
+      self.name = options[:name]
+      self.website = options[:website]
+      self.country = options[:country]
+      self.bitrate = options[:bitrate]
+      self.status = options[:status]
+    end
+
+    class << self
+
+      def create(params)
+        guard_creation_of_station(params)
+        call_api_with_results(
+          request_type: :post,
+          query: 'station/apikey/{{api_key}}',
+          form_fields: params
+        ).first
+      end
+
+      def search(keyword)
+        call_api_with_results(
+          request_type: :get,
+          query: "search/apikey/{{api_key}}/search/#{keyword.parameterize}"
+        )
+      end
+
+      def by_continent(name)
+        call_api_with_results(
+          request_type: :get,
+          query: "continent/apikey/{{api_key}}/continent/#{name.parameterize}"
+        )
+      end
+
+      def by_country(code)
+        call_api_with_results(
+          request_type: :get,
+          query: "country/apikey/{{api_key}}/country/#{code}"
+        )
+      end
+
+      def count
+        response = Dirble.connection.exec_query(
+          request_type: :get,
+          query: 'amountStation/apikey/{{api_key}}'
+        ).body
+        JSON.parse(response)['amount']
+      end
+
+      private
+
+      def guard_creation_of_station(params)
+        unless all_required_fields?(params.keys)
+          raise ArgumentError, 'You forgot about one of this keys: name, website, directory'
+        end
+      end
+
+      def all_required_fields?(keys)
+        REQUIRED_FIELDS.all? { |required_field| keys.include?(required_field) }
+      end
+    end
+  end
+end