beats-client 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@beats-ruby-client --create

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/HISTORY.md

@@ -0,0 +1,21 @@
+
+### 0.1.1 (2012-01-31)
+
+* Secure handling of password input
+* Better handling of network errors and authentication errors
+
+### 0.1.0 (2012-01-31)
+
+* Simple extensible command line interface (CLI)
+* Implemented some basic commands:
+  - help
+  - version
+  - info
+  - show
+  - search
+  - auth:login
+  - auth:logout
+  - account
+  - account:history
+* Secure authentication and credentials handling (stored in ~/.beats/credentials.yml)
+* A basic Beats::Client class for programatic interaction with the Beats API

data/README.md

@@ -0,0 +1,3 @@
+# Beats Client
+
+A CLI client and SDK for Beats API.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+$LOAD_PATH.unshift 'lib'
+
+task :default => [:test]
+
+desc 'Run test suite'
+task :test do
+  Dir.glob('test/**/*_test.rb').each do |file|
+    require File.expand_path(file)
+  end
+end

data/beats-client.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "beats/version"
+
+Gem::Specification.new do |s|
+  s.name        = "beats-client"
+  s.version     = Beats::VERSION
+  s.authors     = ["Niklas Holmgren"]
+  s.email       = ["niklas@sutajio.se"]
+  s.homepage    = "https://github.com/ProjectDaisy/beats-ruby-client"
+  s.summary     = %q{A CLI client and SDK for Beats API}
+  s.description = %q{A CLI client and SDK for Beats API}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rest-client'
+  s.add_dependency 'multi_json'
+  s.add_dependency 'json_pure'
+  s.add_development_dependency 'rake'
+end

data/bin/beats

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'beats'
+require 'beats/command'
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+Beats::Command.run(command, args)

data/lib/beats/auth.rb

@@ -0,0 +1,114 @@
+module Beats
+  class Auth
+    class << self
+
+      def login
+        ask_for_credentials
+      end
+
+      def logout
+        delete_credentials
+      end
+
+      def access_token
+        @credentials ||= read_credentials
+        if @credentials
+          @credentials['access_token']
+        end
+      end
+
+      private
+
+        def running_on_windows?
+          RUBY_PLATFORM =~ /mswin32|mingw32/
+        end
+
+        def home_directory
+          running_on_windows? ? ENV['USERPROFILE'].gsub('\\','/') : ENV['HOME']
+        end
+
+        def credentials_file
+          "#{home_directory}/.beats/credentials.yml"
+        end
+
+        def read_credentials
+          if File.exists?(credentials_file)
+            YAML.load(File.read(credentials_file))
+          end
+        end
+
+        def save_credentials(credentials)
+          FileUtils.mkdir_p(File.dirname(credentials_file))
+          f = File.open(credentials_file, 'w')
+          f.write(YAML.dump(credentials))
+          f.close
+          set_credentials_permissions
+        end
+
+        def set_credentials_permissions
+          FileUtils.chmod 0700, File.dirname(credentials_file)
+          FileUtils.chmod 0600, credentials_file
+        end
+
+        def delete_credentials
+          FileUtils.rm_f(credentials_file)
+        end
+
+        def get_credentials
+          read_credentials || ask_for_credentials
+        end
+
+        def ask_for_password_on_windows
+          require "Win32API"
+          char = nil
+          password = ''
+          while char = Win32API.new("crtdll", "_getch", [ ], "L").Call do
+            break if char == 10 || char == 13 # received carriage return or newline
+            if char == 127 || char == 8 # backspace and delete
+              password.slice!(-1, 1)
+            else
+              # windows might throw a -1 at us so make sure to handle RangeError
+              (password << char.chr) rescue RangeError
+            end
+          end
+          puts
+          return password
+        end
+
+        def ask_for_password
+          if running_on_windows?
+            ask_for_password_on_windows
+          else
+            `stty -echo`
+            trap('INT') do
+              puts
+              `stty echo`
+              exit(1)
+            end
+            password = STDIN.gets.strip
+            puts
+            `stty echo`
+            return password
+          end
+        end
+
+        def ask_for_credentials
+          check_credentials do
+            puts 'Please enter your credentials.'
+            print 'Access token: '
+            access_token = ask_for_password
+          end
+        end
+
+        def check_credentials(&block)
+          access_token = yield
+          Beats::Client.new(:access_token => access_token).account
+          save_credentials('access_token' => access_token)
+        rescue ::RestClient::Unauthorized
+          puts 'Authentication failed.'
+          retry
+        end
+
+    end
+  end
+end

data/lib/beats/client.rb

@@ -0,0 +1,98 @@
+require 'rest_client'
+require 'json'
+require 'multi_json'
+require 'uri'
+require 'base64'
+
+module Beats
+  class Client
+
+    DEFAULT_OPTIONS = {
+      :base_url => ENV['BEATS_URL'] || 'http://prdaisy.com/'
+    }
+
+    # Creates a client object that can be used to interact with the Beats API
+    # @param [Hash] options Configuration options for the client
+    # @option options [String] :base_url The URL the client will use to access
+    #   the API. Defaults to http://prdaisy.com/ or the BEATS_URL environment
+    #   variable if it is set.
+    # @option options [String] :access_token The access token to use for
+    #   requests that require authentication.
+    def initialize(options = {})
+      options = DEFAULT_OPTIONS.merge(options)
+      @base_url = options[:base_url]
+      @access_token = options[:access_token]
+    end
+
+    def index
+      get(@base_url)
+    rescue RestClient::MultipleChoices => e
+      @index ||= decode_json(e.response.body)
+    end
+
+    def account
+      decode_json(get(resolve_uri(@base_url, href(:account))))
+    end
+
+    def resource(uri)
+      decode_json(get(resolve_uri(@base_url, uri)))
+    end
+
+    def search(query)
+      decode_json(get(resolve_uri(@base_url, href(:search)),
+        :params => { :q => query }))
+    end
+
+    def add_history(uri)
+      post(resolve_uri(@base_url, href(:history)),
+        :uri => uri)
+    end
+
+    def sentence
+      decode_json(get(resolve_uri(@base_url, href(:sentence))))
+    end
+
+    private
+
+      def default_headers
+        return @default_headers if @default_headers
+        @default_headers = {}
+        @default_headers[:accept] = :json
+        if @access_token
+          @default_headers[:authorization] =
+            "Bearer #{Base64.encode64(@access_token)}"
+        end
+        @default_headers
+      end
+
+      def get(url, options = {})
+        RestClient.get(url, default_headers.merge(options))
+      end
+
+      def post(url, payload, options = {})
+        RestClient.post(url, payload, default_headers.merge(options))
+      end
+
+      def href(rel, options = {})
+        links = options[:links] || index['links']
+        links.each do |link|
+          return link['href'] if link['rel'] == rel.to_s
+        end
+        raise ArgumentError, "Unknown link \"#{rel}\""
+      end
+
+      def resolve_uri(base_uri, uri)
+        uri = URI.parse(uri)
+        if uri.relative?
+          URI.join(base_uri, uri).to_s
+        else
+          uri.to_s
+        end
+      end
+
+      def decode_json(json)
+        json.is_a?(String) ? MultiJson.decode(json) : json
+      end
+
+  end
+end

data/lib/beats/command.rb

@@ -0,0 +1,77 @@
+require 'beats/commands/base'
+
+Dir["#{File.dirname(__FILE__)}/commands/*.rb"].each { |c| require c }
+
+module Beats
+  module Command
+    class InvalidCommand < RuntimeError; end
+    class CommandFailed < RuntimeError; end
+
+    DEFAULT_COMMAND = 'help'
+
+    class << self
+      def parse(command)
+        command = DEFAULT_COMMAND if command == ''
+        parts = command.split(':')
+        klass = command_class(parts.first)
+        if klass.has_command?(parts.last)
+          [klass, parts.last.to_sym]
+        else
+          raise InvalidCommand, command
+        end
+      end
+
+      def run(command, *args)
+        klass, method = parse(command)
+        klass.new(*args.flatten).send(method)
+      rescue RestClient::Unauthorized => e
+        puts '!!! AUTHENTICATION REQUIRED !!!'
+        run 'auth:login'
+        retry
+      rescue RestClient::RequestTimeout
+        error 'Request timed out. Please try again, or contact support if this issue persists.'
+      rescue RestClient::Exception => e
+        error extract_error(e)
+      rescue SocketError => e
+        error "Unable to connect to server. Your internet connection might be down."
+      rescue InvalidCommand => e
+        error "Unknown command: #{e.to_s}"
+      rescue CommandFailed => e
+        error e.message
+      rescue Interrupt => e
+        error "\n[canceled]"
+      end
+
+      private
+
+        def command_class(command)
+          eval("Beats::Command::#{command.to_s.capitalize}")
+        rescue NameError
+          Beats::Command::Api
+        end
+
+        def error(message)
+          STDERR.puts message
+          exit(1)
+        end
+
+        def extract_error(e)
+          return e.message if e.response.nil?
+          case e.response.headers[:content_type]
+          when 'application/json'
+            error = MultiJson.decode(e.http_body)
+            if error.is_a?(Hash) && error['error']
+              error['error_description'] || error['error']
+            else
+              e.message
+            end
+          when 'text/plain'
+            e.http_body && e.http_body != '' ? e.http_body.to_s : e.message
+          else
+            e.message
+          end
+        end
+
+    end
+  end
+end

data/lib/beats/commands/account.rb

@@ -0,0 +1,19 @@
+module Beats
+  module Command
+    class Account < Base
+
+      def account
+        display YAML.dump(client.account)
+      end
+
+      def history
+        if args.empty?
+          raise CommandFailed, command_usage('account:history', 'URI')
+        else
+          client.add_history(CGI.escape(args.first))
+        end
+      end
+
+    end
+  end
+end

data/lib/beats/commands/api.rb

@@ -0,0 +1,46 @@
+module Beats
+  module Command
+    class Api < Base
+
+      def info
+        display YAML.dump(client.index)
+      end
+
+      def show
+        if args.empty?
+          raise CommandFailed, command_usage('show', 'URI [...]')
+        else
+          display_resources(args.map { |uri|
+            client.resource(CGI.escape(uri))
+          })
+        end
+      end
+
+      def search
+        interactive do |args|
+          query = args.join(' AND ')
+          display "Searching for: \"#{query}\""
+          results = client.search(query)
+          display "#{results['total']} item(s) found"
+          %w(artists albums tracks).each do |collection|
+            next unless results[collection].is_a?(Array)
+            display_resources(results[collection])
+          end
+        end
+      end
+
+      private
+
+        def display_resources(resources)
+          resources.each do |resource|
+            display '-'*80
+            display "URI:  #{resource['uri']}"
+            display "Name: #{resource['name']}"
+            display "Type: #{resource['type']}"
+          end
+          display '-'*80 unless resources.empty?
+        end
+
+    end
+  end
+end

data/lib/beats/commands/auth.rb

@@ -0,0 +1,15 @@
+module Beats
+  module Command
+    class Auth < Base
+
+      def login
+        Beats::Auth.login
+      end
+
+      def logout
+        Beats::Auth.logout
+      end
+
+    end
+  end
+end

data/lib/beats/commands/base.rb

@@ -0,0 +1,54 @@
+require 'readline'
+require 'yaml'
+
+module Beats
+  module Command
+    class Base
+
+      attr_reader :args
+
+      def initialize(*args)
+        @args = args
+      end
+
+      def self.has_command?(command)
+        if self.instance_methods.first.is_a?(Symbol)
+          self.instance_methods.include?(command.to_sym)
+        else
+          self.instance_methods.include?(command.to_s)
+        end
+      end
+
+      protected
+
+        def client
+          @client ||= Beats::Client.new(
+            :access_token => Beats::Auth.access_token)
+        end
+
+        def display(message)
+          puts message
+        end
+
+        def command_usage(command, options)
+          " !    Usage: beats #{command} #{options}"
+        end
+
+        def interactive(&block)
+          if args.empty?
+            display "Interactive mode. Exit with ^D."
+            while line = Readline.readline('> ', true)
+              if line
+                yield([line])
+              else
+                break
+              end
+            end
+          else
+            yield(args)
+          end
+        end
+
+    end
+  end
+end

data/lib/beats/commands/help.rb

@@ -0,0 +1,61 @@
+module Beats
+  module Command
+    class Help < Base
+
+      def help
+        display 'Usage: beats COMMAND [command-specific-options]'
+        space
+        command_group('Help commands (type "beats help COMMAND" for more details):') do
+          command 'help', 'show this help text'
+          command 'version', 'show version information'
+        end
+        command_group('General commands:') do
+          command 'info', 'show detailed service info'
+          command 'show', 'fetch and show a resource'
+          command 'search', 'search in the music catalogue'
+        end
+        command_group('Account commands:') do
+          command 'auth:login', 'authenticate with your account credentials'
+          command 'auth:logout', 'clear saved credentials'
+          command 'account', 'show account info for current user'
+          command 'account:history', 'add something to a users history'
+        end
+        command_group('The sentence:') do
+          command 'sentence', 'show the sentence'
+        end
+      end
+
+      private
+
+        class CommandGroup
+          def initialize(&block)
+            @commands = []
+            instance_eval(&block)
+          end
+          def command(command, description)
+            @commands << [command, description]
+          end
+          def display(&block)
+            max_length = @commands.map {|c| c.first.size }.sort.last
+            @commands.each do |c|
+              command, description = c.first, c.last
+              yield("  #{command.ljust(max_length+2)}# #{description}")
+            end
+          end
+        end
+
+        def command_group(title = nil, &block)
+          display("#{title}\n\n") if title
+          CommandGroup.new(&block).display do |command|
+            display command
+          end
+          space
+        end
+
+        def space
+          display "\n"
+        end
+
+    end
+  end
+end

data/lib/beats/commands/sentence.rb

@@ -0,0 +1,14 @@
+module Beats
+  module Command
+    class Sentence < Base
+
+      def sentence
+        display(client.sentence['fields'].map { |field|
+          option = field['options'][rand(field['options'].size)]
+          [option['prefix'] || field['prefix'], "{#{option['name']}}", option['suffix'] || field['suffix']]
+        }.flatten.compact.join(' '))
+      end
+
+    end
+  end
+end

data/lib/beats/commands/version.rb

@@ -0,0 +1,12 @@
+module Beats
+  module Command
+    class Version < Base
+
+      def version
+        require 'beats/version'
+        display "Beats v#{Beats::VERSION}"
+      end
+
+    end
+  end
+end

data/lib/beats/version.rb

@@ -0,0 +1,3 @@
+module Beats
+  VERSION = '0.2.0'
+end

data/lib/beats.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'beats/version'
+require 'beats/client'
+require 'beats/auth'
+
+module Beats; end

data/test/client_test.rb

@@ -0,0 +1,62 @@
+require File.expand_path('test/test_helper')
+
+class ClientTest < Test::Unit::TestCase
+
+  def setup
+    @client = Beats::Client.new(:access_token => '_ojSy7QjgPJ2gUh3UeQXzAye5aoN-0QoWKmCMxFHuuI')
+  end
+
+  def test_can_resolve_uri
+    assert_equal 'http://example.com/test', @client.send(:resolve_uri, 'http://example.com/foo/', '/test')
+    assert_equal 'http://example.com/foo/test', @client.send(:resolve_uri, 'http://example.com/foo/', 'test')
+    assert_equal 'http://example.com/test', @client.send(:resolve_uri, 'http://example.com/', 'test')
+    assert_equal 'http://test.com/test', @client.send(:resolve_uri, 'http://example.com/foo/', 'http://test.com/test')
+  end
+
+  def test_can_load_index
+    assert @client.index
+    assert @client.index['links']
+  end
+
+  def test_can_load_account
+    assert_equal 'Niklas-Holmgren', @client.account['uri']
+    assert_equal 'Niklas Holmgren', @client.account['name']
+    assert_equal 'Account', @client.account['type']
+  end
+
+  def test_can_load_resource
+    resource = @client.resource('Niklas-Holmgren')
+    assert_equal 'Niklas-Holmgren', resource['uri']
+    assert_equal 'Niklas Holmgren', resource['name']
+    assert_equal 'Account', resource['type']
+  end
+
+  def test_can_search
+    results = @client.search('The Beatles')
+    assert results['total']
+    assert results['page']
+    assert results['per_page']
+    assert results['pages']
+    assert results['artists']
+    assert results['albums']
+    assert results['tracks']
+  end
+
+  def test_can_add_to_history
+    @client.add_history('The-Beatles')
+  end
+
+  def test_can_load_the_sentence
+    sentence = @client.sentence
+    assert_equal false, sentence['fields'].empty?
+    sentence['fields'].each do |field|
+      assert field['prefix']
+      assert field['options']
+      field['options'].each do |option|
+        assert option['id']
+        assert option['name']
+      end
+    end
+  end
+
+end

data/test/command_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path('test/test_helper')
+require 'beats/command'
+
+class Beats::Command::Test < Beats::Command::Base
+  def test; 'success'; end
+  def foo; "#{args[0]},#{args[1]},#{args[2]}"; end
+end
+
+class CommandTest < Test::Unit::TestCase
+
+  def test_should_resolve_commands
+    assert_equal [Beats::Command::Help, :help], Beats::Command.parse('')
+    assert_equal [Beats::Command::Test, :test], Beats::Command.parse('test')
+    assert_equal [Beats::Command::Test, :foo], Beats::Command.parse('test:foo')
+  end
+
+  def test_should_raise_exeption_if_command_could_not_be_resolved
+    assert_raises Beats::Command::InvalidCommand do
+      Beats::Command.parse('foo')
+    end
+    assert_raises Beats::Command::InvalidCommand do
+      Beats::Command.parse('foo:bar')
+    end
+    assert_raises Beats::Command::InvalidCommand do
+      Beats::Command.parse('foo:bar:baz')
+    end
+  end
+
+  def test_should_run_commands
+    assert_equal 'success', Beats::Command.run('test', [])
+    assert_equal '1,2,3', Beats::Command.run('test:foo', [1,2,3])
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+ENV['BEATS_URL'] = 'http://prdaisy.com/'
+
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+require 'beats'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: beats-client
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Niklas Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A CLI client and SDK for Beats API
+email: 
+- niklas@sutajio.se
+executables: 
+- beats
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- HISTORY.md
+- README.md
+- Rakefile
+- beats-client.gemspec
+- bin/beats
+- lib/beats.rb
+- lib/beats/auth.rb
+- lib/beats/client.rb
+- lib/beats/command.rb
+- lib/beats/commands/account.rb
+- lib/beats/commands/api.rb
+- lib/beats/commands/auth.rb
+- lib/beats/commands/base.rb
+- lib/beats/commands/help.rb
+- lib/beats/commands/sentence.rb
+- lib/beats/commands/version.rb
+- lib/beats/version.rb
+- test/client_test.rb
+- test/command_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ProjectDaisy/beats-ruby-client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: A CLI client and SDK for Beats API
+test_files: 
+- test/client_test.rb
+- test/command_test.rb
+- test/test_helper.rb