leipzig 0.0.3 → 0.0.4

data/LICENSE

@@ -1,6 +1,6 @@
-Copyright (c) 2012 Mario Behrendt
+(The MIT License)
 
-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
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -29,9 +29,7 @@ Simply create a new instance of the client using your api key and call one of th
 ```ruby
 require 'leipzig'
 
-key = 'my-key'
-
-client = Leipzig::Mediahandbook.new(key)
+client = Leipzig::Mediahandbook.new('my-key')
 
 companies = client.find_companies(:postcode => '04103')
 branches  = client.find_branches(:limit => 5)
@@ -48,9 +46,13 @@ client.find_companies(:limit => 10).first.name
 # ==> First company's name
 ```
 
-## Note
+Besides `Mediahandbook` there are also classes for `District` and `Calendar` which are used the same way. Again, see
+link above for more information about params and structures. Calls could look as follows:
 
-At the moment only the mediahandbook entries are supported.
+```ruby
+Leipzig::Calendar.new(key).find_events
+Leipzig::District.new(key).find_streets
+```
 
 ## Running the tests
 
@@ -59,16 +61,6 @@ $ 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
-
 ## Todo
 
 * Refactoring

data/lib/leipzig/client.rb

@@ -9,6 +9,9 @@ module Leipzig
 
     attr_reader :api_key
 
+    # Constructor
+    #
+    # @param [String] API Key to use
     def initialize(api_key)
       @api_key = api_key
       @conditions = { :limit => 10, :name => 'leipzig', :api_key => @api_key }
@@ -17,10 +20,18 @@ module Leipzig
 
     private
 
+    # Returns hash of TYPES for instance
+    #
+    # @return [Hash] Available types
     def types
       self.singleton_class.const_get(:TYPES)
     end
 
+    # Generates URI and triggers API call
+    #
+    # @param [String] Type of resource to find
+    # @param [Hash] Conditions
+    # @return [Array] Result set of `request` method
     def find(type, conditions = {})
       raise "Type #{type} is invalid" unless types.include?(type.to_sym)
       uri = "#{API_URL}/#{resource}/#{type}"
@@ -32,10 +43,15 @@ module Leipzig
       request(uri, conditions)
     end
 
+    # Returns true if `conditions` hash includes non-keyword keys, hence search params
+    #
+    # @param [Hash] Conditions to check
+    # @return [Boolean] True if search param was found
     def has_search_param?(conditions)
       conditions.keys.select { |key| !KEYWORDS.include?(key) }.any?
     end
 
+    # Registers find_*-methods for each TYPE on current instance
     def register_methods
       types.each do |type|
         self.class.send(:define_method, "find_#{type}".to_sym) do |*args|
@@ -44,10 +60,19 @@ module Leipzig
       end
     end
 
+    # Returns reource name based on instance class name
+    # For instance "Leipzig::Mediahandbook" leads to "mediahandbook"
+    #
+    # @return [String] Resource name
     def resource
       self.class.to_s.split('::').last.downcase
     end
 
+    # Calls API and returns Array which contains OpenStructs if entries were found
+    #
+    # @param [String] URI to call
+    # @param [Hash] Conditions for call like limit, offset and search params
+    # @return [Array] List of found entries
     def request(uri, conditions)
       result = JSON.parse RestClient.get(uri, :params => @conditions.merge(conditions))
 

data/lib/leipzig/version.rb

@@ -1,3 +1,3 @@
 module Leipzig
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leipzig
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -96,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -953058203614356815
+      hash: 1076362203260376975
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -953058203614356815
+      hash: 1076362203260376975
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24