hermod 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f734b2b05f6e0c454ade409a61f9eb18da49d9ca
-  data.tar.gz: b5feefa69f5f93cc380c7841248b2a30b947b43e
+  metadata.gz: f824eee43c5ddbc599aebe96158698b9861b1b38
+  data.tar.gz: 51b60d86ba5750414a51d383757cab4ee9f8af39
 SHA512:
-  metadata.gz: 0caa25fac9dc0cc74b4f624b480bb7d900f6d625910af7c39758e62ca1d217b96643e8733deefd63a781c41c77460fb6058ee23d75c20d82f22c8c773bc4b4a1
-  data.tar.gz: d680e1797b1316cd5af0ed76b7d4f0c74f25c7147e2e51b99fb7e8d1c0387d6ca0c39b38d3bdd59e90cf14f22e40ca6d4c8634993a0bb289fcffa53bdbeadb5d
+  metadata.gz: a675232e7799a9b03d64f6c4a96043dbaf27cf4f8d31b3e1d01933c920570078d4a22f73c4df5e8e10fe06ba4f1ccc9078d7827469ef0ffbdbdce376ba3c5772
+  data.tar.gz: 8a2cc8a477aab48de66149eb98a54401e56971168e5d656b1d9b9cef52c6f439a3aa1879a706a2f5f491ec8135b7a47287fe87be657a822ac5f9958889ea771a

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 bundler_args: --without test
 rvm:
-  - 2.1.6
-  - 2.2.2
-  - ruby-head
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
 gemfile:
   - gemfiles/activesupport-3.2
   - gemfiles/activesupport-4.0

data/README.md

@@ -266,6 +266,35 @@ end
 </Example>
 ```
 
+#### DateTime Nodes
+
+Datetime nodes let you send through a date and a time to HMRC. It will be
+converted to the given datetime format which you can specify as a format
+string in the `formats` option passed to the `Hermod::XmlSection.build`
+call. Anything that responds to `strftime` can be passed to the node.
+Anything else will cause an `Hermod::InvalidInputError` exception to be raised.
+
+*Building an XmlSection*
+```ruby
+Example = Hermod::XmlSection.build(formats: {datetime: "%Y-%m-%d %H:%M:%S"}) do |builder|
+  builder.datetime_node :published
+end
+```
+
+*Using that XmlSection*
+```ruby
+Example.new do |example|
+  example.published DateTime.new(2014, 9, 3, 10, 42, 50)
+end
+```
+
+*The Resulting XML*
+```xml
+<Example>
+  <Published>2014-09-03 10:42:50</Published>
+</Example>
+```
+
 #### Yes Nodes
 
 Yes nodes allow you to send a boolean value to HMRC provided that value is

data/lib/hermod/version.rb

@@ -1,3 +1,3 @@
 module Hermod
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/lib/hermod/xml_section.rb

@@ -79,7 +79,8 @@ module Hermod
     def self.formats
       @formats ||= {
         date: "%Y-%m-%d",
-        money: "%.2f"
+        datetime: "%Y-%m-%d %H:%M:%S",
+        money: "%.2f",
       }
     end
 

data/lib/hermod/xml_section_builder.rb

@@ -112,6 +112,23 @@ module Hermod
       end
     end
 
+    # Public: defines a node for sending a datetime to HMRC
+    #
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
+    #
+    # Returns nothing you should rely on
+    def datetime_node(name, options={})
+      validators = [].tap do |validators|
+        validators << Validators::ValuePresence.new unless options.delete(:optional)
+        validators << Validators::TypeChecker.new(DateTime) { |value| value.respond_to? :strftime }
+      end
+
+      create_method(name, [], validators, options) do |value, attributes|
+        [(value ? value.strftime(format_for(:datetime)) : nil), attributes]
+      end
+    end
+
     # Public: defines a node for sending a boolean to HMRC. It will only be
     # sent if the boolean is true.
     #

data/spec/hermod/xml_section_builder/datetime_node_spec.rb

@@ -0,0 +1,32 @@
+require "minitest_helper"
+
+module Hermod
+  describe XmlSection do
+
+    DateTimeXml = XmlSection.build do |builder|
+      builder.datetime_node :published
+      builder.datetime_node :redacted, optional: true
+    end
+
+    describe "Date nodes" do
+      subject do
+        DateTimeXml.new do |dummy|
+          dummy.published DateTime.new(2015, 3, 14, 12, 30, 56)
+        end
+      end
+
+      it "should format the datetime with the given format string" do
+        value_of_node("Published").must_equal "2015-03-14 12:30:56"
+      end
+
+      it "should raise an error if given something that isn't a date" do
+        proc { subject.redacted "yesterday" }.must_raise InvalidInputError
+      end
+
+      it "should ignore blank dates if the date is optional" do
+        subject.redacted nil
+        nodes("Redacted").must_be_empty
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermod
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Harry Mills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -175,6 +175,7 @@ files:
 - spec/hermod/validators/value_presence_spec.rb
 - spec/hermod/validators/whole_units_spec.rb
 - spec/hermod/xml_section_builder/date_node_spec.rb
+- spec/hermod/xml_section_builder/datetime_node_spec.rb
 - spec/hermod/xml_section_builder/integer_node_spec.rb
 - spec/hermod/xml_section_builder/monetary_node_spec.rb
 - spec/hermod/xml_section_builder/parent_node_spec.rb
@@ -204,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A Ruby library for talking to the HMRC Government Gateway.
@@ -220,6 +221,7 @@ test_files:
 - spec/hermod/validators/value_presence_spec.rb
 - spec/hermod/validators/whole_units_spec.rb
 - spec/hermod/xml_section_builder/date_node_spec.rb
+- spec/hermod/xml_section_builder/datetime_node_spec.rb
 - spec/hermod/xml_section_builder/integer_node_spec.rb
 - spec/hermod/xml_section_builder/monetary_node_spec.rb
 - spec/hermod/xml_section_builder/parent_node_spec.rb