poczta_polska 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7322e491795261baaea74814da021c85e74f6871
-  data.tar.gz: e43dfa728803d4ec87f47bcf087cbd1b98ba5e2c
+  metadata.gz: 86453aebbd6ee7866cfdca13cbb3486535cbc214
+  data.tar.gz: 8f98488567ec1af6240e80720509cc079da55709
 SHA512:
-  metadata.gz: 512d79b3af228bde0e7e207836308b4189744fd4a21d6e3c40234d2c2bfcd46a5b9772fe523d7409adc272c390cc88a708903db70293159b1171524b010fabf7
-  data.tar.gz: 59c8fac3a62de475997076ef96de874a7af71599d0a44af48bfae57a6988f19dc7c2e8a93ef3558f5ecfd2f25758b08f5f834748874b7e24870323a340a6a380
+  metadata.gz: 42eab5e918c56ef9583431c422a9c46c9dc92153f51ecad1b892d41e4247f24edac40cf5459ab1ffd5460d7975270dad5dddabda5305c010f8acacfaa41001ea
+  data.tar.gz: 7024a795382f937544f44e694667218dd699f2f5ee8012163fdc852e07129f8903f857db9cef24ec9dec5d204ce0ccf786db423385464dfd86bbc133957f62b0

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,5 +1,7 @@
 # PocztaPolska
 
+[Gem at RubyGems.org](https://rubygems.org/gems/poczta_polska) | [Documentation](http://www.rubydoc.info/gems/poczta_polska)
+
 With this gem you can monitor Polish Post parcels and registered mail
 as well as packages shipped by Pocztex. It allows you to see basic data
 about the consignment as well as all the post offices it has gone through
@@ -57,7 +59,7 @@ end
 
 ## Contributing
 
-1. Fork it ( https://github.com/hejmsdz/poczta_polska.rb/fork )
+1. Fork it (https://github.com/hejmsdz/poczta_polska.rb/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/poczta_polska/event.rb

@@ -1,4 +1,3 @@
-require 'poczta_polska/dynamic_reader'
 require 'poczta_polska/office'
 
 module PocztaPolska
@@ -8,21 +7,35 @@ module PocztaPolska
     # @return [Hash] Original data from the XML response
     attr_reader :data
 
-    # Dynamic methods map
-    # @see DynamicReader
-    ATTR_MAP = {
-      time: [:czas, lambda { |time| DateTime.parse(time) }],
-      code: [:kod, :to_sym],
-      name: [:nazwa, :to_s],
-      office: [:jednostka, :nazwa, :to_s],
-      final?: [:konczace, nil]
-    }
-    include DynamicReader
-
     def initialize(data)
       @data = data
     end
 
+    # @return [DateTime] date and time of the event
+    def time
+      DateTime.parse(@data[:czas])
+    end
+
+    # @return [Symbol] code of the event
+    def code
+      @data[:kod].to_sym
+    end
+
+    # @return [String] human-readable name of the event
+    def name
+      @data[:nazwa].to_s
+    end
+
+    # @return [String] name of the post office
+    def office
+      @data[:jednostka][:nazwa].to_s
+    end
+
+    # @return [Boolean] whether this is the final event (delivery, receiving in the post office, etc.)
+    def final?
+      @data[:konczace]
+    end
+
     # Returns detailed information about the post office connected with this event,
     # only if the {Tracker#check}/{Tracker#check_many} method was called
     # with +details+ set to +true+.

data/lib/poczta_polska/package.rb

@@ -1,4 +1,3 @@
-require 'poczta_polska/dynamic_reader'
 require 'poczta_polska/office'
 require 'poczta_polska/event'
 
@@ -9,28 +8,65 @@ module PocztaPolska
     # @return [Hash] Original data from the XML response
     attr_reader :data
 
-    # Dynamic methods map
-    # @see DynamicReader
-    ATTR_MAP = {
-      id: [:numer, :to_s],
-      type: [:dane_przesylki, :kod_rodz_przes, :to_sym],
-      type_str: [:dane_przesylki, :rodz_przes, :to_s],
-      country_from: [:dane_przesylki, :kod_kraju_nadania, :to_sym],
-      country_from_str: [:dane_przesylki, :kraj_nadania, :to_s],
-      country_to: [:dane_przesylki, :kod_kraju_przezn, :to_sym],
-      country_to_str: [:dane_przesylki, :kraj_przezn, :to_s],
-      office_from: [:dane_przesylki, :urzad_nadania, :nazwa, :to_s],
-      office_to: [:dane_przesylki, :urzad_przezn, :nazwa, :to_s],
-      mass: [:dane_przesylki, :masa, nil],
-      ready?: [:dane_przesylki, :zakonczono_obsluge, nil]
-    }
-    
-    include DynamicReader
-
     def initialize(data)
       @data = data
     end
 
+    # @return [String] package ID
+    def id
+      @data[:numer].to_s
+    end
+
+    # @return [Symbol] package type code
+    def type
+      @data[:dane_przesylki][:kod_rodz_przes].to_sym
+    end
+
+    # @return [String] human-readable package type
+    def type_str
+      @data[:dane_przesylki][:rodz_przes].to_s
+    end
+
+    # @return [Symbol] origin country code
+    def country_from
+      @data[:dane_przesylki][:kod_kraju_nadania].to_sym
+    end
+
+    # @return [String] origin country name
+    def country_from_str
+      @data[:dane_przesylki][:kraj_nadania].to_s
+    end
+
+    # @return [Symbol] destination country code
+    def country_to
+      @data[:dane_przesylki][:kod_kraju_przezn].to_sym
+    end
+
+    # @return [String] destination country name
+    def country_to_str
+      @data[:dane_przesylki][:kraj_przezn].to_s
+    end
+
+    # @return [String] origin post office name
+    def office_from
+      @data[:dane_przesylki][:urzad_nadania][:nazwa].to_s
+    end
+
+    # @return [String] destination post office name
+    def office_to
+      @data[:dane_przesylki][:urzad_przezn][:nazwa].to_s
+    end
+
+    # @return [Float] mass of the package
+    def mass
+      @data[:dane_przesylki][:masa]
+    end
+
+    # @return [Boolean] whether the service has been finished (delivered, received in the post office, etc.)
+    def ready?
+      @data[:dane_przesylki][:zakonczono_obsluge]
+    end
+
     # Returns detailed information about the origin post office,
     # only if the {Tracker#check}/{Tracker#check_many} method was called
     # with +details+ set to +true+.

data/lib/poczta_polska/version.rb

@@ -1,3 +1,3 @@
 module PocztaPolska
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/poczta_polska.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["mikolaj.rozwadowski@outlook.com"]
 
   spec.summary       = "Track Polish Post packages in Ruby"
-  spec.description   = "With this gem you can monitor Polish Post parcels and registered mail "
-                       "as well as packages shipped by Pocztex. It allows you to see basic data "
-                       "about the consignment as well as all the post offices it has gone through "
-                       "(including their locations and opening hours). The data is downloaded from "
-                       "[a public SOAP API of the Polish Post](http://www.poczta-polska.pl/pliki/webservices/"
-                       "Metody%20i%20struktury%20uslugi%20sieciowej%20Poczty%20Polskiej%20SA.pdf) "
+  spec.description   = "With this gem you can monitor Polish Post parcels and registered mail " \
+                       "as well as packages shipped by Pocztex. It allows you to see basic data " \
+                       "about the consignment as well as all the post offices it has gone through " \
+                       "(including their locations and opening hours). The data is downloaded from " \
+                       "[a public SOAP API of the Polish Post](http://www.poczta-polska.pl/pliki/webservices/" \
+                       "Metody%20i%20struktury%20uslugi%20sieciowej%20Poczty%20Polskiej%20SA.pdf) " \
                        "and wrapped into Ruby classes for your convenience."
   spec.homepage      = "https://github.com/hejmsdz/poczta_polska.rb"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poczta_polska
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mikołaj Rozwadowski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-13 00:00:00.000000000 Z
+date: 2015-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -100,7 +100,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: 'With this gem you can monitor Polish Post parcels and registered mail '
+description: With this gem you can monitor Polish Post parcels and registered mail
+  as well as packages shipped by Pocztex. It allows you to see basic data about the
+  consignment as well as all the post offices it has gone through (including their
+  locations and opening hours). The data is downloaded from [a public SOAP API of
+  the Polish Post](http://www.poczta-polska.pl/pliki/webservices/Metody%20i%20struktury%20uslugi%20sieciowej%20Poczty%20Polskiej%20SA.pdf)
+  and wrapped into Ruby classes for your convenience.
 email:
 - mikolaj.rozwadowski@outlook.com
 executables: []
@@ -118,7 +123,6 @@ files:
 - bin/setup
 - examples/example.rb
 - lib/poczta_polska.rb
-- lib/poczta_polska/dynamic_reader.rb
 - lib/poczta_polska/event.rb
 - lib/poczta_polska/office.rb
 - lib/poczta_polska/package.rb

data/lib/poczta_polska/dynamic_reader.rb

@@ -1,34 +0,0 @@
-module PocztaPolska
-  # This helper module is +include+d into other classes
-  # and allows to access elements nested in the +@data+ hash.
-  # In order to use it, a class must define a constant hash +ATTR_MAP+.
-  # For the following element in the hash:
-  #
-  # +my_method: [:some, :nested, :value, :to_s]+
-  #
-  # calling +object.my_method+ will return @data[:some][:nested][:value].to_s.
-  # The last element in the array is either a conversion method name, a +Proc+ or +nil+.
-  module DynamicReader
-    # Returns +true+ if the method name is a key in the +ATTR_MAP+ hash.
-    def respond_to_missing?(method, include_private = false)
-      self.class::ATTR_MAP.has_key?(method) || super
-    end
-
-    def method_missing(method)
-      return super unless respond_to_missing?(method)
-
-      keys = self.class::ATTR_MAP[method].dup
-      convert = keys.pop
-      d = @data
-      keys.each { |k| d = d[k] }
-
-      if convert.nil?
-        d
-      elsif convert.is_a?(Proc)
-        convert.call(d)
-      else
-        d.public_send(convert)
-      end
-    end
-  end
-end