memphis 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1334d1c816707816d461d6214ba5eef61b24c3ff
-  data.tar.gz: 7c28d8fe5a9401119454975e1cfaa0fa824cb1c0
+  metadata.gz: fee7a70029c417fcb7d7b4b8748e2a1a35147b97
+  data.tar.gz: 41fa03cf0e65bd71f387d359a4838077add0e86e
 SHA512:
-  metadata.gz: f31fd08d8a6d6d77bac86a1b896c41199b2366f9f46070ca0da74eeedbb364e02d55c2dedb8c5e14e07625f4148f8e6f87980fd6e18fa9d5c092470b63b4b73f
-  data.tar.gz: 5e787ecb1ba5f7f3dfb5c135599ea94ab4252d9a744405ea139c793ac8d8945078af7424c6c23cc382bd81542b7dfdeca9dd63b5f08b6ad27eac7c84e416e234
+  metadata.gz: 9cbe955af034bbf59a6836fecbdbaf410edf6df29174a923f1c926105a35e7402d975ebd6d34264b815f4212360be19d4819c7611ec2930c6c2361ec1aac8c1f
+  data.tar.gz: 8b8dad01426a4c8acb489154beb130dcd936f486f6b7c366884f8815f8ce24584e41f99be1d9250a31ba4422c1692ab2d888c8056f7c9c2694266a83178ed398

data/README.md

@@ -23,10 +23,15 @@ Or install it yourself as:
 ```ruby
 require 'memphis'
 
-memphis = Memphis::Memphis.new ECHONEST_API_KEY
+Memphis.configure do |config|
+  config.api_key = ECHONEST_API_KEY
+end
+
+# Artist Search
+memphis_artist = Memphis::Artist.new
     
 # Search using The Echo Nest ID for Radiohead
-search_result = memphis.search "ARH6W4X1187B99274F"
+search_result = memphis_artist.search "ARH6W4X1187B99274F"
 
 # Show providers includeding in results
 

data/lib/memphis.rb

@@ -1,5 +1,6 @@
-require_relative 'memphis/memphis'
+require_relative 'memphis/configuration'
 require_relative 'memphis/client'
+require_relative 'memphis/artist'
 require_relative 'memphis/result'
 require_relative 'memphis/version'
 
@@ -7,5 +8,5 @@ require 'httparty'
 require 'multi_json'
 
 module Memphis
-
+  extend Configuration
 end

data/lib/memphis/artist.rb

@@ -0,0 +1,14 @@
+module Memphis
+  class Artist < Client
+
+    ARTIST_URI = File.join(::Memphis::Configuration.base_uri, '/artist/profile?')
+
+    def initialize
+      super
+    end
+
+    def search id
+      client_search ARTIST_URI, id
+    end
+  end
+end

data/lib/memphis/client.rb

@@ -3,6 +3,7 @@ module Memphis
     class ConnectionError < Exception; end
     class EmptyAPIKeyError < Exception; end
     class EmptySearchIDError < Exception; end
+    class DirectClientUserError < Exception; end
 
     FOREIGN_PROVIDERS = {
       '7digital-US' => '7digital',
@@ -22,23 +23,21 @@ module Memphis
       'whosampled' => 'who_sampled'
     }
 
-    BASE_URI = 'http://developer.echonest.com/api/v4/artist/profile?'
+    def initialize
+      raise DirectClientUserError, "You cannot instantiate Client class directly" if self.class == Memphis::Client
 
-    def initialize api_key=nil
-      if api_key.to_s == ""
+      if Memphis.api_key.nil?
         raise EmptyAPIKeyError, "If you don't already have an an account, register here: https://developer.echonest.com/account/register"
       end
-
-      @api_key = api_key
     end
 
-    def search id
+    def client_search search_base_uri, id
       if id.to_s == ""
         raise EmptySearchIDError, "need to pass in an The Echo Nest artist ID, such as: \"ARH6W4X1187B99274F\""
       end
 
       @id = id
-      results_hash = get_foreign_id_hash
+      results_hash = get_foreign_id_hash search_base_uri
 
       result = Result.new(results_hash)
 
@@ -47,9 +46,9 @@ module Memphis
 
     private
 
-    def get_foreign_id_hash
-      uri = BASE_URI
-      uri += "api_key=#{@api_key}"
+    def get_foreign_id_hash search_base_uri
+      uri = search_base_uri
+      uri += "api_key=#{Memphis.api_key}"
       uri += "&id=#{@id}"
       uri += provider_params
 

data/lib/memphis/configuration.rb

@@ -0,0 +1,24 @@
+module Memphis
+  module Configuration
+    DEFAULT_API_KEY = nil
+    BASE_URI = 'http://developer.echonest.com/api/v4/'
+
+    attr_accessor :api_key
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.api_key = DEFAULT_API_KEY
+    end
+
+    def self.base_uri
+      BASE_URI
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/memphis/version.rb

@@ -1,3 +1,3 @@
 module Memphis
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/client_spec.rb

@@ -1,30 +1,61 @@
 require 'spec_helper'
 
+module Memphis
+  class TestSearch < Memphis::Client
+    URI = 'http://www.example.com'
+
+    def initialize
+      super
+    end
+
+    def search id
+      client_search URI, id
+    end
+  end
+end
+
 describe Memphis::Client do
   describe '#initialize' do
-    context 'invalid API key' do
-      context 'empty API key' do
-        it 'throws EmptyAPIKeyException' do
-          expect{Memphis::Client.new "" }.to raise_exception Memphis::Client::EmptyAPIKeyError
-        end
+    context 'instantiated directly' do
+      it 'raises DirectClientUserError' do
+        expect{Memphis::Client.new}.to raise_exception Memphis::Client::DirectClientUserError
       end
     end
+    context 'not instantiated directly' do
+      context 'invalid API key' do
+        context 'empty API key' do
+          it 'throws EmptyAPIKeyException' do
+            Memphis.api_key = nil
+            expect{Memphis::TestSearch.new}.to raise_exception Memphis::TestSearch::EmptyAPIKeyError
+          end
+        end
+      end
 
-    context 'valid API key' do
+      context 'valid API key' do
 
+      end
     end
-  end
 
-  describe '#search' do
-    context 'invalid search ID' do
-      let(:client) { Memphis::Client.new "fake_API_key" }
-      context 'empty search ID' do
-        it 'throws EmptySearchIDException' do
-          expect{client.search "" }.to raise_exception Memphis::Client::EmptySearchIDError
+    describe '#search' do
+      let(:client) { Memphis::TestSearch.new}
+
+      before(:each) do
+        Memphis.configure do |config|
+          config.api_key = 'FAKEKEY'
         end
       end
-    end
 
-  end
+      after(:each) do
+        Memphis.reset
+      end
 
+      context 'invalid search ID' do
+        context 'empty search ID' do
+          it 'throws EmptySearchIDException' do
+            expect{client.search "" }.to raise_exception Memphis::Client::EmptySearchIDError
+          end
+        end
+      end
+    end
+  end
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Memphis::Configuration do
+  describe '#api_key' do
+    it 'should return default key' do
+      Memphis.api_key.should eq Memphis::Configuration::DEFAULT_API_KEY
+    end
+
+    after do
+      Memphis.reset
+    end
+  end
+
+  describe '#configure' do
+      it "should set the api_key" do
+        Memphis.configure do |config|
+          test_key = 'test_key'
+          config.api_key = test_key
+          Memphis.api_key.should eq test_key
+        end
+      end
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memphis
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Nick Messick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -124,12 +124,14 @@ files:
 - README.md
 - Rakefile
 - lib/memphis.rb
+- lib/memphis/artist.rb
 - lib/memphis/client.rb
-- lib/memphis/memphis.rb
+- lib/memphis/configuration.rb
 - lib/memphis/result.rb
 - lib/memphis/version.rb
 - memphis.gemspec
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -151,11 +153,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Use The Echo Nest's Rosetta Stone project to look up IDs for various other
   services.
 test_files:
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/spec_helper.rb

data/lib/memphis/memphis.rb

@@ -1,14 +0,0 @@
-module Memphis
-  class Memphis
-    attr_accessor :result
-
-    def initialize api_key=nil
-      @client = Client.new api_key
-    end
-
-    def search id
-      @result = @client.search id
-    end
-
-  end
-end