leipzig 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mario Behrendt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Leipzig
+
+Tiny client for [API Leipzig](http://www.apileipzig.de)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'leipzig'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install leipzig
+```
+
+## Usage
+
+Simply create a new instance of the client using your api key and call one of the `find` methods:
+
+```ruby
+require 'leipzig'
+
+key = 'my-key'
+
+client = Leipzig::Client.new(key)
+
+companies = client.find_companies(:postcode => '04103')
+branches  = client.find_branches(:limit => 5)
+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.
+
+## Note
+
+At the moment only the mediahandbook entries are supported.
+
+## Running the tests
+
+```bash
+$ bundle
+$ API_KEY='my-key' rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch
+3. Write code and tests
+4. Check tests
+5. Commit your changes if tests pass
+6. Push to the branch
+7. Create new Pull Request
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 Mario Behrendt info@mario-behrendt.de
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run unit specs'
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/{*_spec.rb,leipzig/**/*_spec.rb}'
+end
+
+task :default => :spec

data/leipzig.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/leipzig/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mario Behrendt"]
+  gem.email         = ["info@mario-behrendt.de"]
+  gem.description   = %q{Tiny client for API Leipzig}
+  gem.summary       = %q{Tiny client for API Leipzig}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "leipzig"
+  gem.require_paths = ["lib"]
+  gem.version       = Leipzig::VERSION
+
+  gem.add_dependency 'rest-client'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/leipzig/client.rb

@@ -0,0 +1,37 @@
+require 'rest-client'
+require 'json'
+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 }
+    end
+
+    def find(type, conditions)
+      raise "Type #{type} is invalid" unless TYPES.include?(type.to_sym)
+
+      uri = "#{API_URL}#{type}/search"
+
+      result = JSON.parse(RestClient.get(uri, :params => @options.merge(conditions)))
+
+      if result.has_key? "error"
+        raise "Webservice returned error for uri '#{uri}': #{result['error']}"
+      end
+
+      result['data'].map { |entry| OpenStruct.new(entry) }
+    end
+  end
+end

data/lib/leipzig/version.rb

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

data/lib/leipzig.rb

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

data/spec/leipzig/client_spec.rb

@@ -0,0 +1,38 @@
+require 'leipzig/client'
+
+KEY = ENV['API_KEY']
+LIMIT = 5
+
+describe 'Client' do
+  let(:client) { Leipzig::Client.new(KEY) }
+
+  it 'returns given API key' do
+    client.api_key.should eq(KEY)
+  end
+
+  it 'reponds to all three mediahandbook types' do
+    client.should respond_to(:find_branches)
+    client.should respond_to(:find_companies)
+    client.should respond_to(:find_people)
+  end
+
+  it 'returns json representation of resource with default limit' do
+    data = client.find_companies(:limit => LIMIT)
+    data.should be_instance_of(Array)
+    data.size.should eq(LIMIT)
+  end
+
+  it 'takes search parameter into account' do
+    zip = '04319'
+    data = client.find_companies(:limit => 2, :postcode => zip)
+    data.map { |company| company.postcode.should eq(zip) }
+  end
+
+  it 'raises exception if invalid key is used' do
+    lambda { Leipzig::Client.new('wrong').find_companies }.should raise_error
+  end
+
+  it 'raises exception if undefined method is called' do
+    lambda { client.find_something }.should raise_error
+  end
+end

data/spec/leipzig/version_spec.rb

@@ -0,0 +1,7 @@
+require 'leipzig/version'
+
+describe 'Version' do
+  it 'returns version string' do
+    Leipzig::VERSION.should match(/\d\.\d\.\d/)
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: leipzig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mario Behrendt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Tiny client for API Leipzig
+email:
+- info@mario-behrendt.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- leipzig.gemspec
+- lib/leipzig.rb
+- lib/leipzig/client.rb
+- lib/leipzig/version.rb
+- spec/leipzig/client_spec.rb
+- spec/leipzig/spec_helper.rb
+- spec/leipzig/version_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1631967839568932202
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1631967839568932202
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Tiny client for API Leipzig
+test_files:
+- spec/leipzig/client_spec.rb
+- spec/leipzig/spec_helper.rb
+- spec/leipzig/version_spec.rb