blitzr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15443180400e38c1fead56fed6513ce4f947247a
+  data.tar.gz: 771bad462202823904ef62b009e5c012338d60c1
+SHA512:
+  metadata.gz: fbe2627f1991fe1665cf3e67c7bad78b2f78e6a307a04e0459c2266a804efeb2ee0a2d9bf0fe8e6c5d7f75cbd1bfbfa20d83ec2715c1980c7dbf7c7ff99a57d5
+  data.tar.gz: 6be113bfefcf3303dad40fd2377c01e87de9fd7a900da5877a1cee37b835c1bea8cbccf0fbd7fd2ce41a7a06d720e3fe6a4b1cbd5ab8db142b4bb861aef07060

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,47 @@
+# Blitzr Ruby Client 
+
+A Ruby client for the [Blitzr API](http://api.blitzr.com/doc/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blitzr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blitzr
+
+## Usage
+
+This library is a Ruby client you can use to interact with the [Blitzr API](http://api.blitzr.com/doc/).
+
+Here's a short example.
+
+```ruby
+require 'blitzr'
+
+client = Blitzr::Client.new(api_key: 'YOUR_KEY')
+
+# Get an artist biography
+biography = client.artist.biography({slug: 'oxmo-puccino')
+puts "Biography: %s (lang: %s)" % [biography.text, biography.lang]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/craftsmen/niland-blitzr-ruby/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,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = !!ENV['VERBOSE']
+end
+
+task test: :spec
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blitzr"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blitzr.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blitzr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blitzr'
+  spec.version       = Blitzr::VERSION
+  spec.authors       = ['Grégoire Colson']
+  spec.email         = ['gregoire.colson@1d-lab.eu']
+
+  spec.summary       = 'A Ruby client for the Blitzr API'
+  spec.description   = 'A Ruby client for the Blitzr API'
+  spec.homepage      = 'https://github.com/craftsmen/niland-blitzr-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency  'httparty'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+end

data/lib/blitzr.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+module Blitzr
+  # Your code goes here...
+end
+
+require 'blitzr/version'
+require 'blitzr/default'
+require 'blitzr/client'
+require 'blitzr/error'

data/lib/blitzr/client.rb

@@ -0,0 +1,93 @@
+require 'blitzr/extra'
+require 'blitzr/struct'
+require 'blitzr/client/clients'
+
+module Blitzr
+  class Client
+    attr_accessor :api_endpoint, :api_key, :user_agent, :requests_timeout
+
+    def initialize(options = {})
+      defaults = Blitzr::Default.options
+
+      Blitzr::Default.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || defaults[key])
+      end
+
+      @services = {}
+    end
+
+    def get(path, options = {})
+      execute :get, path, options
+    end
+
+    def post(path, options = {})
+      execute :post, path, options
+    end
+
+    def patch(path, options = {})
+      execute :patch, path, options
+    end
+
+    def delete(path, options = {})
+      execute :delete, path, options
+    end
+
+    def execute(method, path, data, options = {})
+      response = request(method, path, data, options)
+
+      case response.code
+      when 200..299
+        response
+      when 401
+        raise AuthenticationFailed, response['message']
+      when 404
+        raise NotFoundError.new(response)
+      else
+        raise RequestError.new(response)
+      end
+    end
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query] = data.delete(:query) if data.key?(:query)
+        options[:headers] = data.delete(:headers) if data.key?(:headers)
+      end
+      if !data.empty?
+        options[:body] = data.to_json
+      end
+      HTTParty.send(method, api_endpoint + path, Extra.deep_merge!(base_options, options))
+    end
+
+    def api_endpoint
+      File.join(@api_endpoint, '')
+    end
+
+    private
+
+    def base_options
+      options = {
+        format: :json,
+        headers: {
+          'Accept' => 'application/json',
+          'Content-type' => 'application/json',
+          'User-Agent' => user_agent
+        },
+        query: {
+          _format: 'json'    
+        }
+      }
+
+      if requests_timeout
+        options.merge!(timeout: requests_timeout)
+      end
+
+      if api_key
+        Extra.deep_merge!(options, {query: { key: api_key }})
+      else
+        raise Error, 'An API key is required for all API requests.'
+      end
+
+      options
+    end
+  end
+end

data/lib/blitzr/client/artist.rb

@@ -0,0 +1,36 @@
+module Blitzr
+  class Client
+    module Artist
+
+      # Search for an artist
+      #
+      # @see http://api.blitzr.com/doc#get--artist-
+      def details(query = {})
+        options = { query: query }
+        response = client.get('artist', options)
+
+        Struct::Artist.new(response)
+      end
+
+      # Search for an artist biography
+      #
+      # @see http://api.blitzr.com/doc#get--artist-biography-
+      def biography(query = {})
+        options = { query: query }
+        response = client.get('artist/biography', options)
+
+        Struct::Biography.new(response['biography'])
+      end
+
+      # Search for an artist summary
+      #
+      # @see http://api.blitzr.com/doc#get--artist-summary-
+      def summary(query = {})
+        options = { query: query }
+        response = client.get('artist/summary', options)
+
+        response['summary']
+      end
+    end
+  end
+end

data/lib/blitzr/client/clients.rb

@@ -0,0 +1,26 @@
+module Blitzr
+  class Client
+
+    def artist
+      @services[:artist] ||= Client::ArtistService.new(self)
+    end
+
+    def label
+      @services[:label] ||= Client::LabelService.new(self)
+    end
+
+    class ClientService < ::Struct.new(:client)
+    end
+
+    require 'blitzr/client/artist'
+    require 'blitzr/client/label'
+
+    class ArtistService < ClientService
+      include Client::Artist
+    end
+
+    class LabelService < ClientService
+      include Client::Label
+    end
+  end
+end

data/lib/blitzr/client/label.rb

@@ -0,0 +1,26 @@
+module Blitzr
+  class Client
+    module Label
+
+      # Search for a label
+      #
+      # @see http://api.blitzr.com/doc#get--label-
+      def details(query = {})
+        options = { query: query }
+        response = client.get('label', options)
+
+        Struct::Label.new(response)
+      end
+
+      # Search for a label biography
+      #
+      # @see http://api.blitzr.com/doc#get--label-biography-
+      def biography(query = {})
+        options = { query: query }
+        response = client.get('label/biography', options)
+
+        Struct::Biography.new(response['biography'])
+      end
+    end
+  end
+end

data/lib/blitzr/default.rb

@@ -0,0 +1,32 @@
+module Blitzr
+  module Default
+    API_ENDPOINT = "http://api.blitzr.com/".freeze
+    USER_AGENT = "blitzr-ruby/#{VERSION}".freeze
+
+    class << self
+      def keys
+        @keys ||= [:api_endpoint, :api_key, :user_agent, :requests_timeout]
+      end
+
+      def options
+        Hash[keys.map { |key| [key, send(key)] }]
+      end
+
+      def api_endpoint
+        ENV['SIILAR_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      def api_key
+        ENV['SIILAR_API_KEY']
+      end
+
+      def requests_timeout
+        ENV['SIILAR_REQUESTS_TIMEOUT'] || 10
+      end
+
+      def user_agent
+        ENV['SIILAR_USER_AGENT'] || USER_AGENT
+      end
+    end
+  end
+end

data/lib/blitzr/error.rb

@@ -0,0 +1,22 @@
+module Blitzr
+  class Error < StandardError
+  end
+
+  class RequestError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super("#{response.code}")
+    end
+  end
+
+  class NotFoundError < RequestError
+  end
+
+  class AuthenticationError < Error
+  end
+
+  class AuthenticationFailed < AuthenticationError
+  end
+end

data/lib/blitzr/extra.rb

@@ -0,0 +1,48 @@
+module Blitzr
+  module Extra
+
+    # Returns a new hash with `self` and `other` merged recursively.
+    #
+    #   h1 = { a: true, b: { c: [1, 2, 3] } }
+    #   h2 = { a: false, b: { x: [3, 4, 5] } }
+    #
+    #   h1.deep_merge(h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+    #
+    # Like with Hash#merge in the standard library, a block can be provided
+    # to merge values:
+    #
+    #   h1 = { a: 100, b: 200, c: { c1: 100 } }
+    #   h2 = { b: 250, c: { c1: 200 } }
+    #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
+    #   # => { a: 100, b: 450, c: { c1: 300 } }
+    def self.deep_merge(this, other, &block)
+      deep_merge!(this.dup, other, &block)
+    end
+
+    # Same as `deep_merge`, but modifies `self`.
+    def self.deep_merge!(this, other, &block)
+      other.each_pair do |current_key, other_value|
+        this_value = this[current_key]
+
+        this[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+          deep_merge(this_value, other_value, &block)
+        else
+          if block_given? && key?(current_key)
+            block.call(current_key, this_value, other_value)
+          else
+            other_value
+          end
+        end
+      end
+
+      this
+    end
+
+    # Validates the presence of mandatory attributes.
+    def self.validate_mandatory_attributes(attributes, required)
+      required.each do |name|
+        attributes.key?(name) or raise(ArgumentError, ":#{name} is required")
+      end
+    end
+  end
+end

data/lib/blitzr/struct.rb

@@ -0,0 +1,18 @@
+module Blitzr
+  module Struct
+
+    class Base
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          m = "#{key}=".to_sym
+          self.send(m, value) if self.respond_to?(m)
+        end
+      end
+    end
+  end
+end
+
+require 'blitzr/struct/biography'
+require 'blitzr/struct/tag'
+require 'blitzr/struct/artist'
+require 'blitzr/struct/label'

data/lib/blitzr/struct/artist.rb

@@ -0,0 +1,15 @@
+module Blitzr
+  module Struct
+    class Artist < Base
+      attr_accessor :image, :thumb_300, :thumb, :uuid, :name, :real_name, :slug, :type, :begin_date, :location, :location_code, :has_duplicate
+
+      def tags
+        @tags ||= []
+      end
+
+      def tags=(attrs)
+        @tags = attrs.map { |tag| Struct::Tag.new(tag) }
+      end
+    end
+  end
+end

data/lib/blitzr/struct/biography.rb

@@ -0,0 +1,7 @@
+module Blitzr
+  module Struct
+    class Biography < Base
+      attr_accessor :text, :url, :lang, :source
+    end
+  end
+end

data/lib/blitzr/struct/label.rb

@@ -0,0 +1,15 @@
+module Blitzr
+  module Struct
+    class Label < Base
+      attr_accessor :image, :thumb_300, :thumb, :uuid, :name, :slug, :location, :location_code, :has_duplicate
+
+      def tags
+        @tags ||= []
+      end
+
+      def tags=(attrs)
+        @tags = attrs.map { |tag| Struct::Tag.new(tag) }
+      end
+    end
+  end
+end

data/lib/blitzr/struct/tag.rb

@@ -0,0 +1,7 @@
+module Blitzr
+  module Struct
+    class Tag < Base
+      attr_accessor :weight, :name, :slug
+    end
+  end
+end

data/lib/blitzr/version.rb

@@ -0,0 +1,3 @@
+module Blitzr
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: blitzr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grégoire Colson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-12 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: 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: webmock
+  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: A Ruby client for the Blitzr API
+email:
+- gregoire.colson@1d-lab.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blitzr.gemspec
+- lib/blitzr.rb
+- lib/blitzr/client.rb
+- lib/blitzr/client/artist.rb
+- lib/blitzr/client/clients.rb
+- lib/blitzr/client/label.rb
+- lib/blitzr/default.rb
+- lib/blitzr/error.rb
+- lib/blitzr/extra.rb
+- lib/blitzr/struct.rb
+- lib/blitzr/struct/artist.rb
+- lib/blitzr/struct/biography.rb
+- lib/blitzr/struct/label.rb
+- lib/blitzr/struct/tag.rb
+- lib/blitzr/version.rb
+homepage: https://github.com/craftsmen/niland-blitzr-ruby
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the Blitzr API
+test_files: []