leipzig 0.0.1 → 0.0.2

data/README.md

@@ -31,7 +31,7 @@ require 'leipzig'
 
 key = 'my-key'
 
-client = Leipzig::Client.new(key)
+client = Leipzig::Mediahandbook.new(key)
 
 companies = client.find_companies(:postcode => '04103')
 branches  = client.find_branches(:limit => 5)
@@ -41,6 +41,13 @@ people    = client.find_people(:offset => 100)
 All `find` methods except a hash of params which are used to change the result set. See [this link](http://www.apileipzig.de/wiki/show/allgemeineParameter) for more
 information about available params.
 
+The result set is always an array containing OpenStruct objects so one can access entry data like properties:
+
+```ruby
+client.find_companies(:limit => 10).first.name
+# ==> First company's name
+```
+
 ## Note
 
 At the moment only the mediahandbook entries are supported.
@@ -62,6 +69,12 @@ $ API_KEY='my-key' rake
 6. Push to the branch
 7. Create new Pull Request
 
+## Todo
+
+* Support for whole API and all available resources
+* Refactoring
+* Maybe model layer instead of OpenStruct?
+
 ## License
 
 (The MIT License)

data/lib/leipzig/client.rb

@@ -4,28 +4,17 @@ require 'ostruct'
 
 module Leipzig
   class Client
-    TYPES   = [:companies, :branches, :people]
-    API_URL = 'http://www.apileipzig.de/api/v1/mediahandbook/'
-
     attr_reader :api_key
 
-    TYPES.each do |type|
-      define_method "find_#{type}" do |*args|
-        find(type, *args)
-      end
-    end
-
     def initialize(api_key)
       @api_key = api_key
-      @options = { :limit => 10, :name => 'leipzig', :api_key => @api_key }
+      @options = {}
     end
 
-    def find(type, conditions)
-      raise "Type #{type} is invalid" unless TYPES.include?(type.to_sym)
-
-      uri = "#{API_URL}#{type}/search"
+    private
 
-      result = JSON.parse(RestClient.get(uri, :params => @options.merge(conditions)))
+    def request(uri, params)
+      result = JSON.parse RestClient.get(uri, :params => @options.merge(params))
 
       if result.has_key? "error"
         raise "Webservice returned error for uri '#{uri}': #{result['error']}"

data/lib/leipzig/mediahandbook.rb

@@ -0,0 +1,25 @@
+require 'leipzig/client'
+
+module Leipzig
+  class Mediahandbook < Leipzig::Client
+
+    TYPES   = [:companies, :branches, :people]
+    API_URL = 'http://www.apileipzig.de/api/v1/mediahandbook/'
+
+    TYPES.each do |type|
+      define_method "find_#{type}" do |*args|
+        find(type, *args)
+      end
+    end
+
+    def initialize(api_key)
+      super
+      @options = { :limit => 10, :name => 'leipzig', :api_key => @api_key }
+    end
+
+    def find(type, conditions)
+      raise "Type #{type} is invalid" unless TYPES.include?(type.to_sym)
+      request("#{API_URL}#{type}/search", conditions)
+    end
+  end
+end

data/lib/leipzig/version.rb

@@ -1,3 +1,3 @@
 module Leipzig
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/leipzig.rb

@@ -1,6 +1,3 @@
 require 'leipzig/version'
 require 'leipzig/client'
-
-module Leipzig
-
-end
+require 'leipzig/mediahandbook'

data/spec/leipzig/{client_spec.rb → mediahandbook_spec.rb}

@@ -1,10 +1,10 @@
-require 'leipzig/client'
+require 'leipzig/mediahandbook'
 
 KEY = ENV['API_KEY']
 LIMIT = 5
 
-describe 'Client' do
-  let(:client) { Leipzig::Client.new(KEY) }
+describe 'Mediahandbook' do
+  let(:client) { Leipzig::Mediahandbook.new(KEY) }
 
   it 'returns given API key' do
     client.api_key.should eq(KEY)
@@ -29,7 +29,7 @@ describe 'Client' do
   end
 
   it 'raises exception if invalid key is used' do
-    lambda { Leipzig::Client.new('wrong').find_companies }.should raise_error
+    lambda { Leipzig::Mediahandbook.new('wrong').find_companies }.should raise_error
   end
 
   it 'raises exception if undefined method is called' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leipzig
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -75,8 +75,9 @@ files:
 - leipzig.gemspec
 - lib/leipzig.rb
 - lib/leipzig/client.rb
+- lib/leipzig/mediahandbook.rb
 - lib/leipzig/version.rb
-- spec/leipzig/client_spec.rb
+- spec/leipzig/mediahandbook_spec.rb
 - spec/leipzig/spec_helper.rb
 - spec/leipzig/version_spec.rb
 homepage: ''
@@ -93,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1631967839568932202
+      hash: -3565537231393772397
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1631967839568932202
+      hash: -3565537231393772397
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -110,6 +111,6 @@ signing_key:
 specification_version: 3
 summary: Tiny client for API Leipzig
 test_files:
-- spec/leipzig/client_spec.rb
+- spec/leipzig/mediahandbook_spec.rb
 - spec/leipzig/spec_helper.rb
 - spec/leipzig/version_spec.rb