zeit 0.0.1pre2 → 0.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zeit (0.0.1pre2)
+    zeit (0.0.1)
       faraday
 
 GEM
@@ -20,6 +20,7 @@ GEM
     guard-rspec (2.1.2)
       guard (>= 1.1)
       rspec (~> 2.11)
+    json (1.7.5)
     listen (0.6.0)
     lumberjack (1.0.2)
     method_source (0.8.1)
@@ -40,6 +41,7 @@ GEM
     slop (3.3.3)
     thor (0.16.0)
     vcr (2.3.0)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
@@ -48,7 +50,9 @@ DEPENDENCIES
   bundler (~> 1.0)
   fakeweb (~> 1.3.0)
   guard-rspec (~> 2.1.2)
+  json (~> 1.7.5)
   rb-fsevent
   rspec (~> 2.12.0)
   vcr (~> 2.3.0)
+  yard
   zeit!

data/README.md

@@ -1,6 +1,13 @@
 # Zeit
 
-TODO: Write a gem description
+This gem is a ruby 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
+the past years. To access thir API you'll have to create an api-key which allows you to
+make 10.000 requests per day, free of charge for non-commercial usage.
+
+See http://developer.zeit.de/quickstart/
 
 ## Installation
 
@@ -18,7 +25,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+    require 'zeit'
+    require 'json'
+    
+    zeit = Zeit::API.new :api_key => 'aaabbccccdddeeeeeeffgggg'
+    
+    # author
+    result = zeit.author.find '*Schmidt*'
+    
+    data = JSON.parse(result.body)
+    data['matches'].inspect
+
+    # content
+    result = zeit.content.find '*Software*', :limit => 200, :offset => 100
+    
+    data = JSON.parse(result.body)
+    data['matches'].inspect
+    
+    # department
+    result = zeit.department.find '*internet*'
+    ...
+
+    # keyword
+    result = zeit.keyword.find '*internet*'
+    ...
+
+    # product
+    result = zeit.product.find '*ZEIT*'
+
+    # series
+    result = zeit.series.find 'Die*'
+   
+    # client
+    result = zeit.client.get
+    data = JSON.parse(result.body)
+    # => {"reset"=>1353785293,
+    #  "name"=>"my name",
+    #  "quota"=>10000,
+    #  "tier"=>"free",
+    #  "requests"=>192,
+    #  "api_key"=>"aaaaaaaabbbbbbbbbbcccc",
+    #  "email"=>"email@example.com"}
+
 
 ## Contributing
 

data/lib/zeit/api.rb

@@ -3,6 +3,7 @@ module Zeit
 
     def initialize(params = {})
       @api_key         = params[:api_key]
+      @debug           = params[:debug]
       @base_url        = params[:base_url]        || 'http://api.zeit.de/'
       @faraday_adapter = params[:faraday_adapter] || Faraday.default_adapter
 
@@ -12,10 +13,10 @@ module Zeit
     end
 
     def connection
-      @connection ||= Faraday.new(url: @base_url) do |faraday|
+      @connection ||= Faraday.new(:url => @base_url) do |faraday|
         faraday.use      Zeit::AuthenticationMiddleware, @api_key
         faraday.request  :url_encoded
-        faraday.response :logger
+        faraday.response(:logger) if @debug
         faraday.adapter  @faraday_adapter
       end
     end

data/lib/zeit/resources/author.rb

@@ -1,7 +1,8 @@
 module Zeit
   module Resources
     class Author < Base
-      def find(query, opts = {})
+      def find(q, opts = {})
+        opts[:q] = q
         @connection.get '/author' do |query|
           apply_params(query, opts)
         end

data/lib/zeit/version.rb

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

data/spec/resources/author_spec.rb

@@ -7,7 +7,7 @@ describe Zeit::Resources::Author, :vcr 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*' }
+        let(:query) { '*Schmidt*' }
 
         context 'when authorized' do
           it_behaves_like 'a successful response with some matches'

data/spec/spec_helper.rb

@@ -12,10 +12,10 @@ 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
 end
 
 def unauthorized_api_client
-  Zeit::API.new api_key: 'felix_von_springer' # bild.css
+  Zeit::API.new :api_key => 'felix_von_springer' # bild.css
 end
 

data/zeit.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday'
 
   gem.add_development_dependency 'bundler',     '~> 1.0'
+  gem.add_development_dependency 'json',        '~> 1.7.5'
   gem.add_development_dependency 'rspec',       '~> 2.12.0'
   gem.add_development_dependency 'guard-rspec', '~> 2.1.2'
   gem.add_development_dependency 'rb-fsevent'
   gem.add_development_dependency 'vcr',         '~> 2.3.0'
   gem.add_development_dependency 'fakeweb',     '~> 1.3.0'
+  gem.add_development_dependency 'yard'
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: zeit
 version: !ruby/object:Gem::Version
-  version: 0.0.1pre2
-  prerelease: 5
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Roland Moriz
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +139,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: API client for Zeit.de API
 email:
 - roland@moriz.de
@@ -176,13 +208,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -777588896169395003
+      hash: 1998897930141795511
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 1998897930141795511
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -201,3 +236,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_resources.rb
 - spec/support/vcr.rb
+has_rdoc: