dcentralized 0.0.2 → 0.0.3

data/README.md

@@ -25,22 +25,24 @@ Add file `config/initializers/dcentralized.rb`.
       config.api_key = "123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ"
     end
 
-## Usage
-
-**Example**
-
-    Dcentralized.auto_complete("2564AZ")
-    # => {
-      :nl_sixpp => "2564AZ",
-      :street => "Laan van Meerdervoort",
-      :city => "'s-Gravenhage",
-      :municipality => "'s-Gravenhage",
-      :province => "Zuid-Holland",
-      :streetnumbers => "1096-1126",
-      :lat => "52.06751",
-      :lng => "4.24733",
-      :areacode => "070"
-    }
+## Example usage
+
+High detailed zipcode result:
+
+    response = Dcentralized.auto_complete("2564AZ")
+    # => #<OpenStruct nl_sixpp="2564AZ", street="Laan van Meerdervoort", city="'s-Gravenhage", municipality="'s-Gravenhage", province="Zuid-Holland", streetnumbers="1096-1126", lat="52.06751", lng="4.24733", areacode="070">
+
+Low detailed zipcode result:
+
+    response = Dcentralized.auto_complete("2564")
+    # => #<OpenStruct nl_fourpp="2564", city="'s-Gravenhage", municipality="'s-Gravenhage", province="Zuid-Holland", areacode="070", lat="52.068", lng="4.25724">
+
+You can then use:
+
+    response.street
+    # => "Laan van Meerdervoort"
+    response.province
+    # => "Zuid-Holland"
 
 ## Contributing
 

data/lib/dcentralized.rb

@@ -1,11 +1,12 @@
 require "rest-client"
 require "xmlsimple"
 require "hash_symbolizer"
+require "ostruct"
 require "dcentralized/version"
 
 module Dcentralized
   class << self
-    attr_accessor :api_url, :auth_key
+    attr_accessor :api_url, :api_key
     def configure(&blk); class_eval(&blk); end
   end
 
@@ -13,12 +14,14 @@ module Dcentralized
     # Format the zipcode
     zipcode = format_zipcode(zipcode)
     # Setup request
-    params   = {auth_key: @auth_key} 
+    params  = {auth_key: @api_key} 
     zipcode.length == 6 ? params.merge!(nl_sixpp: zipcode) : params.merge!(nl_fourpp: zipcode)
     params.merge!(format: 'xml', pretty: 'True')
-    # Perform request and return output
+    # Perform request
     response = RestClient.get "#{@api_url}/autocomplete", {params: params}
-    stringify(XmlSimple.xml_in(response)["results"][0]["result"][0].symbolize_keys(true))
+    hash     = XmlSimple.xml_in(response)["results"][0]["result"][0].symbolize_keys(true)
+    # Return openstruct output
+    OpenStruct.new stringify(hash)
   end
 
   def self.format_zipcode(zipcode = nil)
@@ -47,5 +50,5 @@ end
 # Set default configuration
 Dcentralized.configure do
   @api_url  = "http://api.pro6pp.nl/v1"
-  @auth_key = "123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ"
+  @api_key = "123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ"
 end

data/lib/dcentralized/version.rb

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

data/spec/lib/dcentralized_spec.rb

@@ -32,8 +32,8 @@ describe Dcentralized do
         :lng => "4.24733",
         :areacode => "070"
       }
-      Dcentralized.auto_complete("2564AZ").should eq xml_response_mock
-      Dcentralized.auto_complete("2564AZ").should include(:street)
+      Dcentralized.auto_complete("2564AZ").should eq OpenStruct.new(xml_response_mock)
+      Dcentralized.auto_complete("2564AZ").street.should eq "Laan van Meerdervoort"
     end
   end
 
@@ -48,8 +48,8 @@ describe Dcentralized do
         :lat => "52.068",
         :lng => "4.25724"
       }
-      Dcentralized.auto_complete("2564").should eq xml_response_mock
-      Dcentralized.auto_complete("2564").should_not include(:street)
+      Dcentralized.auto_complete("2564").should eq OpenStruct.new(xml_response_mock)
+      Dcentralized.auto_complete("2564").street.should eq nil
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dcentralized
 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: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -170,12 +170,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1491342071412150727
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1491342071412150727
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25