zeit 0.0.2 → 0.0.3

data/.gitignore

@@ -22,3 +22,6 @@ pkg
 
 ## PROJECT::SPECIFIC
 report.html
+
+.rbenv-version
+.rbenv-vars

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    zeit (0.0.2)
+    zeit (0.0.3)
       faraday
+      faraday_middleware
 
 GEM
   remote: https://rubygems.org/
@@ -12,6 +13,8 @@ GEM
     fakeweb (1.3.0)
     faraday (0.8.4)
       multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
     guard (1.5.4)
       listen (>= 0.4.2)
       lumberjack (>= 1.0.2)
@@ -21,6 +24,7 @@ GEM
       guard (>= 1.1)
       rspec (~> 2.11)
     json (1.7.5)
+    json (1.7.5-java)
     listen (0.6.0)
     lumberjack (1.0.2)
     method_source (0.8.1)
@@ -29,6 +33,11 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.3.1)
+    pry (0.9.10-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+      spoon (~> 0.0)
     rake (10.0.2)
     rb-fsevent (0.9.2)
     rspec (2.12.0)
@@ -40,11 +49,13 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)
     slop (3.3.3)
+    spoon (0.0.1)
     thor (0.16.0)
     vcr (2.3.0)
     yard (0.8.3)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/README.md

@@ -1,6 +1,6 @@
 # Zeit
 
-This gem is a ruby client for the Zeit.de API (http://developer.zeit.de/).
+This gem is a ruby 1.9+ client for the Zeit.de API (http://developer.zeit.de/).
 
 The german newspaper "Die Zeit" recently announced a so called "content
 API" to access their large collection of printed and online articles of
@@ -37,15 +37,11 @@ Or install it yourself as:
     
     # author
     result = zeit.author.find '*Schmidt*'
-    
-    data = JSON.parse(result.body)
-    data['matches'].inspect
+    result['matches'].inspect
 
     # content
     result = zeit.content.find '*Software*', :limit => 200, :offset => 100
-    
-    data = JSON.parse(result.body)
-    data['matches'].inspect
+    result['matches'].inspect
     
     # department
     result = zeit.department.find '*internet*'
@@ -63,7 +59,6 @@ Or install it yourself as:
    
     # client
     result = zeit.client.get
-    data = JSON.parse(result.body)
     # => {"reset"=>1353785293,
     #  "name"=>"my name",
     #  "quota"=>10000,
@@ -87,4 +82,4 @@ see LICENSE.txt
 
 ## Copyright
 
-2012 Roland Moriz, https://roland.io/
+2012 Roland Moriz, https://roland.io/

data/lib/zeit.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'faraday_middleware'
 
 require 'zeit/version'
 require 'zeit/resources/base'

data/lib/zeit/api.rb

@@ -6,19 +6,13 @@ module Zeit
       @debug           = params[:debug]
       @base_url        = params[:base_url]        || 'http://api.zeit.de/'
       @faraday_adapter = params[:faraday_adapter] || Faraday.default_adapter
+      @faraday         = params[:faraday]         || default_faraday
 
       raise ArgumentError, ':api_key missing' unless @api_key
-
-      connection
     end
 
     def connection
-      @connection ||= Faraday.new(:url => @base_url) do |faraday|
-        faraday.use      Zeit::AuthenticationMiddleware, @api_key
-        faraday.request  :url_encoded
-        faraday.response(:logger) if @debug
-        faraday.adapter  @faraday_adapter
-      end
+      @faraday
     end
 
     def author(opts = {})
@@ -48,5 +42,17 @@ module Zeit
     def series(opts = {})
       Zeit::Resources::Series.new(connection, opts)
     end
+
+    private
+
+    def default_faraday
+      Faraday.new(:url => @base_url) do |faraday|
+        faraday.use      Zeit::AuthenticationMiddleware, @api_key
+        faraday.request  :url_encoded
+        faraday.response :json
+        faraday.response(:logger) if @debug
+        faraday.adapter @faraday_adapter
+      end
+    end
   end
 end

data/lib/zeit/resources/series.rb

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

data/lib/zeit/version.rb

@@ -1,3 +1,3 @@
 module Zeit
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/spec/resources/author_spec.rb

@@ -35,7 +35,7 @@ describe Zeit::Resources::Author, :vcr do
           end
 
           it 'should have the right data type' do
-            parsed_json['type'].should eql('author')
+            json['type'].should eql('author')
           end
         end
 

data/spec/resources/client_spec.rb

@@ -11,8 +11,8 @@ describe Zeit::Resources::Client, :vcr do
         it_behaves_like 'a successful response'
 
         it 'should return information about the api usage of the current account' do
-         parsed_json.has_key? 'requests'
-         parsed_json.has_key? 'tier'
+         json.has_key? 'requests'
+         json.has_key? 'tier'
         end
       end
 

data/spec/resources/content_spec.rb

@@ -33,12 +33,12 @@ describe Zeit::Resources::Content, :vcr do
 
         context 'when authorized' do
           it 'should have some important values' do
-            parsed_json.has_key? 'title'
+            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)
+            json['creators'].should   be_instance_of(Array)
+            json['relations'].should  be_instance_of(Array)
+            json['keywords'].should   be_instance_of(Array)
+            json['categories'].should be_instance_of(Array)
           end
         end
 

data/spec/resources/department_spec.rb

@@ -35,9 +35,9 @@ describe Zeit::Resources::Department, :vcr 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'
+            json.has_key? 'uri'
+            json.has_key? 'value'
+            json.has_key? 'href'
           end
         end
 

data/spec/resources/keyword_spec.rb

@@ -35,9 +35,9 @@ describe Zeit::Resources::Keyword, :vcr 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'
+            json.has_key? 'uri'
+            json.has_key? 'value'
+            json.has_key? 'href'
           end
         end
 

data/spec/resources/product_spec.rb

@@ -1,52 +1,51 @@
 require 'spec_helper'
 
 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
+  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) { 'zede' }
+
+        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
+            json.has_key? 'uri'
+            json.has_key? 'value'
+            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

@@ -13,7 +13,7 @@ describe Zeit::Resources::Series, :vcr 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) }
+            let(:keys) { %w(uri href) }
           end
         end
 
@@ -25,10 +25,12 @@ describe Zeit::Resources::Series, :vcr do
   end
 
   describe '#get' do
-    pending "Zeit.de currently broken (/series/id) :-("
+    # FIXME still broken at api.zeit.de :(
+    #
+    #
     #it_behaves_like 'a resource response' do
     #  context 'with an valid series id' do
-    #    let(:id) { 'die-einzelkaempfer' }
+    #    let(:id) { 'ausprobiert' }
 
     #    subject { Zeit::Resources::Series.new(api_connection).get(id) }
 
@@ -36,9 +38,9 @@ describe Zeit::Resources::Series, :vcr 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'
+    #        json.has_key? 'uri'
+    #        json.has_key? 'value'
+    #        json.has_key? 'href'
     #      end
     #    end
 
@@ -46,7 +48,6 @@ describe Zeit::Resources::Series, :vcr do
     #      it_behaves_like 'an unauthorized request'
     #    end
     #  end
-
     #end
   end
 end

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ 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
+  Zeit::API.new :api_key => key, :debug => true
 end
 
 def unauthorized_api_client

data/spec/support/shared_examples_for_resources.rb

@@ -9,7 +9,6 @@ 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
@@ -20,7 +19,7 @@ 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
+    json['matches'].should have_at_least(10).items
   end
 end
 
@@ -35,7 +34,7 @@ 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
+    json['description'].should_not be_empty
   end
 end
 
@@ -43,7 +42,7 @@ end
 # 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|
+    json['matches'].each do |match|
       keys.each do |required_key|
         match.keys.should include(required_key)
       end

data/zeit.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['roland@moriz.de']
   gem.description   = %q{API client for Zeit.de API}
   gem.summary       = %q{API client for Zeit.de API}
-  gem.homepage      = "http://github.com/rmoriz/zeit"
+  gem.homepage      = 'http://github.com/rmoriz/zeit'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/).select { |file| file !~ /^spec\/vcr/ }
@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
   end
 
   gem.add_dependency 'faraday'
+  gem.add_dependency 'faraday_middleware'
 
   gem.add_development_dependency 'bundler',     '~> 1.0'
   gem.add_development_dependency 'json',        '~> 1.7.5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +241,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4197996778355535057
+      hash: 2203375178907227553
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -234,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4197996778355535057
+      hash: 2203375178907227553
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23