zeit 0.0.1pre → 0.0.1pre2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zeit (0.0.1pre)
+    zeit (0.0.1pre2)
       faraday
 
 GEM

data/lib/zeit/api.rb

@@ -2,28 +2,50 @@ module Zeit
   class API
 
     def initialize(params = {})
-      @api_key  = params[:api_key]
-      @base_url = params[:base_url] || 'http://api.zeit.de:80/'
+      @api_key         = params[:api_key]
+      @base_url        = params[:base_url]        || 'http://api.zeit.de/'
+      @faraday_adapter = params[:faraday_adapter] || Faraday.default_adapter
+
+      raise ArgumentError, ':api_key missing' unless @api_key
 
       connection
     end
 
     def connection
       @connection ||= Faraday.new(url: @base_url) do |faraday|
-        #faraday.request  :url_encoded
         faraday.use      Zeit::AuthenticationMiddleware, @api_key
+        faraday.request  :url_encoded
         faraday.response :logger
-        faraday.adapter  Faraday.default_adapter
+        faraday.adapter  @faraday_adapter
       end
     end
 
-    def author
-      Zeit::Resources::Author.new connection
+    def author(opts = {})
+      Zeit::Resources::Author.new(connection, opts)
+    end
+
+    def client(opts = {})
+      Zeit::Resources::Client.new(connection, opts)
+    end
+
+    def content(opts = {})
+      Zeit::Resources::Content.new(connection, opts)
     end
 
-    def client
-      Zeit::Resources::Client.new connection
+    def department(opts = {})
+      Zeit::Resources::Department.new(connection, opts)
     end
 
+    def keyword(opts = {})
+      Zeit::Resources::Keyword.new(connection, opts)
+    end
+
+    def product(opts = {})
+      Zeit::Resources::Product.new(connection, opts)
+    end
+
+    def series(opts = {})
+      Zeit::Resources::Series.new(connection, opts)
+    end
   end
 end

data/lib/zeit/resources/author.rb

@@ -1,7 +1,17 @@
 module Zeit
   module Resources
     class Author < Base
+      def find(query, opts = {})
+        @connection.get '/author' do |query|
+          apply_params(query, opts)
+        end
+      end
 
+      def get(id, opts = {})
+        @connection.get "/author/#{id}" do |query|
+          apply_params(query, opts)
+        end
+      end
     end
   end
 end

data/lib/zeit/resources/base.rb

@@ -6,14 +6,25 @@ module Zeit
       attr_accessor :limit
       attr_accessor :offset
 
-      def initialize(connection)
+      def initialize(connection, options = {})
         @connection = connection
+
+        @limit = options[:limit] || 10
         @fields = []
       end
-    end
 
-    def get
-    end
+      private
+
+      def apply_params(query, opts)
+        apply_default_params(query)
 
+        opts.each_pair do |key, value|
+          query.params[key] = value
+        end
+      end
+
+      def apply_default_params(query)
+      end
+    end
   end
 end

data/lib/zeit/resources/client.rb

@@ -1,16 +1,11 @@
 module Zeit
   module Resources
     class Client < Base
-      def client
-        raw_client
+      def get
+        @connection.get '/client'
       end
 
-      def raw_client
-        @connection.get '/client' do |request|
-        end
-      end
-
-      alias_method :get, :client
+      alias_method :client, :get
     end
   end
 end

data/lib/zeit/resources/content.rb

@@ -1,7 +1,18 @@
 module Zeit
   module Resources
     class Content < Base
+      def find(q, opts = {})
+        opts[:q] = q
+        @connection.get '/content' do |query|
+          apply_params(query, opts)
+        end
+      end
 
+      def get(id, opts = {})
+        @connection.get "/content/#{id}" do |query|
+          apply_params(query, opts)
+        end
+      end
     end
   end
 end

data/lib/zeit/resources/department.rb

@@ -1,7 +1,18 @@
 module Zeit
   module Resources
     class Department < Base
+      def find(q, opts = {})
+        opts[:q] = q
+        @connection.get '/department' do |query|
+          apply_params(query, opts)
+        end
+      end
 
+      def get(id, opts = {})
+        @connection.get "/department/#{id}" do |query|
+          apply_params(query, opts)
+        end
+      end
     end
   end
 end

data/lib/zeit/resources/keyword.rb

@@ -1,7 +1,18 @@
 module Zeit
   module Resources
     class Keyword < Base
+      def find(q, opts = {})
+        opts[:q] = q
+        @connection.get '/keyword' do |query|
+          apply_params(query, opts)
+        end
+      end
 
+      def get(id, opts = {})
+        @connection.get "/keyword/#{id}" do |query|
+          apply_params(query, opts)
+        end
+      end
     end
   end
 end

data/lib/zeit/resources/product.rb

@@ -1,7 +1,18 @@
 module Zeit
   module Resources
     class Product < Base
+      def find(q, opts = {})
+        opts[:q] = q
+        @connection.get '/product' do |query|
+          apply_params(query, opts)
+        end
+      end
 
+      def get(id, opts = {})
+        @connection.get "/product/#{id}" do |query|
+          apply_params(query, opts)
+        end
+      end
     end
   end
 end

data/lib/zeit/resources/series.rb

@@ -1,7 +1,18 @@
 module Zeit
   module Resources
     class Series < Base
+      def find(q, opts = {})
+        opts[:q] = q
+        @connection.get '/product' do |query|
+          apply_params(query, opts)
+        end
+      end
 
+      def get(id, opts = {})
+        @connection.get "/product/#{id}" do |query|
+          apply_params(query, opts)
+        end
+      end
     end
   end
 end

data/lib/zeit/version.rb

@@ -1,3 +1,3 @@
 module Zeit
-  VERSION = "0.0.1pre"
+  VERSION = "0.0.1pre2"
 end

data/spec/api_spec.rb

@@ -1,27 +1,48 @@
 require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::API' do
-  describe '.inititalize' do
+describe Zeit::API do
+  subject { authorized_api_client }
+
+  describe '.new' do
     it 'should be able to initialized with an api_key' do
-      zeit = Zeit::API.new api_key: 'something'
-      zeit.should be_instance_of(Zeit::API)
+      subject.should be_instance_of(Zeit::API)
+    end
+
+    it 'should initialize a faraday connection object' do
+      subject.connection.should be_instance_of(Faraday::Connection)
     end
 
-    it 'should initialize a faraday  connection object' do
-      zeit = Zeit::API.new api_key: 'something'
-      zeit.connection.should be_instance_of(Faraday::Connection)
+    it 'should raise an error when :api_key parameter is missing' do
+      expect { Zeit::API.new }.to raise_error
     end
   end
 
-  describe '.author' do
-    subject { Zeit::API.new api_key: 'something' }
+  describe '#author' do
     its(:author) { should be_instance_of(Zeit::Resources::Author) }
   end
 
-  describe '.client' do
-    subject { Zeit::API.new api_key: 'something' }
+  describe '#client' do
     its(:client) { should be_instance_of(Zeit::Resources::Client) }
   end
 
+  describe '#content' do
+    its(:content) { should be_instance_of(Zeit::Resources::Content) }
+  end
+
+  describe '#department' do
+    its(:department) { should be_instance_of(Zeit::Resources::Department) }
+  end
+
+  describe '#keyword' do
+    its(:keyword) { should be_instance_of(Zeit::Resources::Keyword) }
+  end
+
+  describe '#product' do
+    its(:product) { should be_instance_of(Zeit::Resources::Product) }
+  end
+
+  describe '#series' do
+    its(:series) { should be_instance_of(Zeit::Resources::Series) }
+  end
 end

data/spec/resources/author_spec.rb

@@ -1,10 +1,51 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Author' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Author.new }.to raise_error
+describe Zeit::Resources::Author, :vcr do
+  it_behaves_like 'a resource'
+
+  describe '#find' do
+    context 'with a simple query' do
+      it_behaves_like 'a resource response' do
+        subject { Zeit::Resources::Author.new(api_connection).find(query) }
+        let(:query) { '*Helmut*Schmidt*' }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like 'a resource response' do
+
+      context 'with an valid author id' do
+        subject { Zeit::Resources::Author.new(api_connection).get(author_id) }
+        let(:author_id) { 'Helmut-Schmidt' }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it_behaves_like 'all matches have the required keys' do
+            let(:keys) { %w(subtitle uuid title href release_date uri supertitle teaser_title) }
+          end
+
+          it 'should have the right data type' do
+            parsed_json['type'].should eql('author')
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
     end
   end
+
+
 end
+

data/spec/resources/client_spec.rb

@@ -1,19 +1,24 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Client' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Client.new }.to raise_error
-    end
-  end
+describe Zeit::Resources::Client, :vcr do
+  it_behaves_like 'a resource'
+
+  describe '#get' do
+    it_behaves_like 'a resource response' do
+      subject { Zeit::Resources::Client.new(api_connection).get }
+
+      context 'when authorized' do
+        it_behaves_like 'a successful response'
 
-  describe '#client' do
-    let(:api) { Zeit::API.new api_key: 'whatever' }
-    subject { Zeit::Resources::Client.new api.connection }
+        it 'should return information about the api usage of the current account' do
+         parsed_json.has_key? 'requests'
+         parsed_json.has_key? 'tier'
+        end
+      end
 
-    it 'should return information about the api usage of the current account' do
-      #subject.client
+      context 'when unauthorized' do
+        it_behaves_like 'an unauthorized request'
+      end
     end
   end
 end

data/spec/resources/content_spec.rb

@@ -1,10 +1,53 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Content' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Content.new }.to raise_error
+describe Zeit::Resources::Content, :vcr do
+  it_behaves_like 'a resource'
+
+  describe '#find' do
+    context 'with a simple query' do
+      it_behaves_like 'a resource response' do
+        let(:query) { 'Kim Schmitz' }
+        subject { Zeit::Resources::Content.new(api_connection).find(query) }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it_behaves_like 'all matches have the required keys' do
+            let(:keys) { %w(subtitle uuid title href release_date uri supertitle snippet teaser_title) }
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like 'a resource response' do
+      context 'with an valid content id' do
+        let(:uuid) { '3GbcIDjwbcH4DZKMZj0Ndd' }
+
+        subject { Zeit::Resources::Content.new(api_connection).get(uuid) }
+
+        context 'when authorized' do
+          it 'should have some important values' do
+            parsed_json.has_key? 'title'
+
+            parsed_json['creators'].should   be_instance_of(Array)
+            parsed_json['relations'].should  be_instance_of(Array)
+            parsed_json['keywords'].should   be_instance_of(Array)
+            parsed_json['categories'].should be_instance_of(Array)
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+
     end
   end
 end
+

data/spec/resources/department_spec.rb

@@ -1,10 +1,52 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Department' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Department.new }.to raise_error
+describe Zeit::Resources::Department, :vcr do
+  it_behaves_like 'a resource'
+
+  describe '#find' do
+    context 'with a simple query' do
+      it_behaves_like 'a resource response' do
+        let(:query) { '*i*' }
+        subject { Zeit::Resources::Department.new(api_connection).find(query) }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it_behaves_like 'all matches have the required keys' do
+            let(:keys) { %w(href uri value) }
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like 'a resource response' do
+      context 'with an valid department id' do
+        let(:id) { 'internet' }
+
+        subject { Zeit::Resources::Department.new(api_connection).get(id) }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it 'should have some important values' do
+            parsed_json.has_key? 'uri'
+            parsed_json.has_key? 'value'
+            parsed_json.has_key? 'href'
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+
     end
   end
 end
+

data/spec/resources/keyword_spec.rb

@@ -1,10 +1,51 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Keyword' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Keyword.new }.to raise_error
+describe Zeit::Resources::Keyword, :vcr do
+  it_behaves_like 'a resource'
+
+  describe '#find' do
+    context 'with a simple query' do
+      it_behaves_like 'a resource response' do
+        let(:query) { '*rom*' }
+        subject { Zeit::Resources::Keyword.new(api_connection).find(query) }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it_behaves_like 'all matches have the required keys' do
+            let(:keys) { %w(href uri value type) }
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like 'a resource response' do
+      context 'with an valid keyword id' do
+        let(:id) { 'internet' }
+
+        subject { Zeit::Resources::Keyword.new(api_connection).get(id) }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it 'should have some important values' do
+            parsed_json.has_key? 'uri'
+            parsed_json.has_key? 'value'
+            parsed_json.has_key? 'href'
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
+
     end
   end
 end

data/spec/resources/product_spec.rb

@@ -1,10 +1,52 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Product' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Product.new }.to raise_error
-    end
-  end
+describe Zeit::Resources::Product, :vcr do
+  pending "Zeit.de broken (product) :-("
+  #it_behaves_like 'a resource'
+
+  #describe '#find' do
+  #  context 'with a simple query' do
+  #    it_behaves_like 'a resource response' do
+  #      let(:query) { 'ZEIT*' }
+  #      subject { Zeit::Resources::Product.new(api_connection).find(query) }
+
+  #      context 'when authorized' do
+  #        it_behaves_like 'a successful response with some matches'
+
+  #        it_behaves_like 'all matches have the required keys' do
+  #          let(:keys) { %w(uri) }
+  #        end
+  #      end
+
+  #      context 'when unauthorized' do
+  #        it_behaves_like 'an unauthorized request'
+  #      end
+  #    end
+  #  end
+  #end
+
+  #describe '#get' do
+  #  it_behaves_like 'a resource response' do
+  #    context 'with an valid product id' do
+  #      let(:id) { 'tpi' }
+
+  #      subject { Zeit::Resources::Product.new(api_connection).get(id) }
+
+  #      context 'when authorized' do
+  #        it_behaves_like 'a successful response with some matches'
+
+  #        it 'should have some important values' do
+  #          parsed_json.has_key? 'uri'
+  #          parsed_json.has_key? 'value'
+  #          parsed_json.has_key? 'href'
+  #        end
+  #      end
+
+  #      context 'when unauthorized' do
+  #        it_behaves_like 'an unauthorized request'
+  #      end
+  #    end
+
+  #  end
+  #end
 end

data/spec/resources/series_spec.rb

@@ -1,10 +1,52 @@
-require 'zeit'
 require 'spec_helper'
 
-describe 'Zeit::Resources::Series' do
-  describe '.new' do
-    it 'should require a connection object to be initalized' do
-      expect { Zeit::Resources::Series.new }.to raise_error
+describe Zeit::Resources::Series, :vcr do
+  it_behaves_like 'a resource'
+
+  describe '#find' do
+    context 'with a simple query' do
+      it_behaves_like 'a resource response' do
+        let(:query) { '*er*' }
+        subject { Zeit::Resources::Series.new(api_connection).find(query) }
+
+        context 'when authorized' do
+          it_behaves_like 'a successful response with some matches'
+
+          it_behaves_like 'all matches have the required keys' do
+            let(:keys) { %w(uri value) }
+          end
+        end
+
+        context 'when unauthorized' do
+          it_behaves_like 'an unauthorized request'
+        end
+      end
     end
   end
+
+  describe '#get' do
+    pending "Zeit.de currently broken (/series/id) :-("
+    #it_behaves_like 'a resource response' do
+    #  context 'with an valid series id' do
+    #    let(:id) { 'die-einzelkaempfer' }
+
+    #    subject { Zeit::Resources::Series.new(api_connection).get(id) }
+
+    #    context 'when authorized' do
+    #      it_behaves_like 'a successful response with some matches'
+
+    #      it 'should have some important values' do
+    #        parsed_json.has_key? 'uri'
+    #        parsed_json.has_key? 'value'
+    #        parsed_json.has_key? 'href'
+    #      end
+    #    end
+
+    #    context 'when unauthorized' do
+    #      it_behaves_like 'an unauthorized request'
+    #    end
+    #  end
+
+    #end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,21 @@
-require 'vcr'
+require 'zeit'
+require 'json'
 
-VCR.configure do |c|
-  c.cassette_library_dir = 'spec/vcr/cassettes'
-  c.hook_into :fakeweb
+RSpec.configure do |c|
+  # VCR:
+  # so we can use :vcr rather than :vcr => true;
+  # in RSpec 3 this will no longer be necessary.
+  c.treat_symbols_as_metadata_keys_with_true_values = true
 end
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+def authorized_api_client
+  key = ENV['ZEIT_API_KEY'] || 'working'
+  Zeit::API.new api_key: key
+end
+
+def unauthorized_api_client
+  Zeit::API.new api_key: 'felix_von_springer' # bild.css
+end
+

data/spec/support/shared_examples_for_resources.rb

@@ -0,0 +1,54 @@
+shared_examples 'a resource' do
+  describe '.new' do
+    it 'should require a connection object to be initalized' do
+      expect { described_class.new }.to raise_error
+    end
+  end
+end
+
+shared_examples 'a resource response' do
+  let(:json) { subject.body }
+  let(:api_connection) { authorized_api_client.connection }
+  let(:parsed_json) { JSON.parse(json) }
+end
+
+shared_examples 'a successful response' do
+  its(:success?) { should be_true }
+end
+
+shared_examples 'a successful response with some matches' do
+  it_behaves_like 'a successful response'
+
+  it 'should return matches' do
+    parsed_json['matches'].should have_at_least(10).items
+  end
+end
+
+shared_examples 'an unauthorized request' do
+  let(:api_connection) { unauthorized_api_client.connection }
+  its(:status) { should eql(401) } # UNAUTHORIZED
+
+  it_behaves_like 'an error message response'
+end
+
+shared_examples 'an error message response' do
+  its(:success?) { should be_false }
+
+  it 'should return an error message' do
+    parsed_json['description'].should_not be_empty
+  end
+end
+
+# todo custom matchers
+# FIXME allow new keys
+shared_examples 'all matches have the required keys' do
+  it 'matches should have at least the basic keys' do
+    parsed_json['matches'].each do |match|
+      keys.each do |required_key|
+        match.keys.should include(required_key)
+      end
+    end
+  end
+end
+
+

data/spec/support/vcr.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr/cassettes'
+  c.hook_into :fakeweb
+  c.configure_rspec_metadata!
+end
+

data/zeit.gemspec

@@ -12,12 +12,11 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{API client for Zeit.de API, not working yet}
   gem.homepage      = "http://github.com/rmoriz/zeit"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($/).select { |file| file !~ /^spec\/vcr/ }
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/}).select { |file| file !~ /^spec\/vcr/ }
   gem.require_paths = ['lib']
 
-
   if RUBY_PLATFORM == 'java'
     gem.add_runtime_dependency 'jruby-openssl'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeit
 version: !ruby/object:Gem::Version
-  version: 0.0.1pre
+  version: 0.0.1pre2
   prerelease: 5
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-24 00:00:00.000000000 Z
+date: 2012-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,6 +159,8 @@ files:
 - spec/resources/product_spec.rb
 - spec/resources/series_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples_for_resources.rb
+- spec/support/vcr.rb
 - zeit.gemspec
 homepage: http://github.com/rmoriz/zeit
 licenses: []
@@ -174,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3422590589912785467
+      hash: -777588896169395003
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -197,3 +199,5 @@ test_files:
 - spec/resources/product_spec.rb
 - spec/resources/series_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples_for_resources.rb
+- spec/support/vcr.rb