Merge pull request #77 from twingly/to_h

Add Post#to_h for both LiveFeed and Search

Author: dentarg

lib/twingly/livefeed/post.rb

@@ -61,6 +61,32 @@ def set_values(params)
         @blog_rank     = params.fetch('blogRank').to_i
         @authority     = params.fetch('authority').to_i
       end
+
+      # @return [Hash] a hash containing all post attributes.
+      def to_h
+        {
+          id: @id,
+          author: @author,
+          url: @url,
+          title: @title,
+          text: @text,
+          language_code: @language_code,
+          location_code: @location_code,
+          coordinates: @coordinates,
+          links: @links,
+          tags: @tags,
+          images: @images,
+          indexed_at: @indexed_at,
+          published_at: @published_at,
+          reindexed_at: @reindexed_at,
+          inlinks_count: @inlinks_count,
+          blog_id: @blog_id,
+          blog_name: @blog_name,
+          blog_url: @blog_url,
+          blog_rank: @blog_rank,
+          authority: @authority,
+        }
+      end
     end
   end
 end

lib/twingly/search/post.rb

@@ -84,6 +84,32 @@ def outlinks
         warn "[DEPRECATION] `outlinks` is deprecated. Please use `links` instead."
         links
       end
+
+      # @return [Hash] a hash containing all post attributes.
+      def to_h
+        {
+          id: @id,
+          author: @author,
+          url: @url,
+          title: @title,
+          text: @text,
+          language_code: @language_code,
+          location_code: @location_code,
+          coordinates: @coordinates,
+          links: @links,
+          tags: @tags,
+          images: @images,
+          indexed_at: @indexed_at,
+          published_at: @published_at,
+          reindexed_at: @reindexed_at,
+          inlinks_count: @inlinks_count,
+          blog_id: @blog_id,
+          blog_name: @blog_name,
+          blog_url: @blog_url,
+          blog_rank: @blog_rank,
+          authority: @authority,
+        }
+      end
     end
   end
 end

spec/livefeed/post_spec.rb

@@ -23,4 +23,51 @@ module Twingly::LiveFeed
     it { should respond_to :blog_rank }
     it { should respond_to :authority }
   end
+
+  describe "#to_h" do
+    let(:post) do
+      document = Fixture.livefeed_get(:valid)
+      result = Parser.new.parse(document)
+
+      result.posts.first
+    end
+
+    let(:post_hash) do
+      post.to_h
+    end
+
+    attributes = %i[
+      id
+      author
+      url
+      title
+      text
+      location_code
+      language_code
+      coordinates
+      links
+      tags
+      images
+      indexed_at
+      published_at
+      reindexed_at
+      inlinks_count
+      blog_id
+      blog_name
+      blog_url
+      blog_rank
+      authority
+    ]
+
+    it do
+      expect(post_hash.keys).to match_array(attributes)
+    end
+
+    attributes.each do |key|
+      describe "#to_h[:#{key}]" do
+        subject { post_hash[key] }
+        it { is_expected.to eq(post.public_send(key)) }
+      end
+    end
+  end
 end

spec/post_spec.rb

@@ -23,6 +23,7 @@
   it { should respond_to :blog_url }
   it { should respond_to :blog_rank }
   it { should respond_to :authority }
+  it { should respond_to :to_h }
 
   deprecated_methods = %i(summary indexed published outlinks)
   deprecated_methods.each do |method_name|
@@ -33,4 +34,51 @@
       end
     end
   end
+
+  describe "#to_h" do
+    let(:post) do
+      document = Fixture.get(:minimal_valid)
+      result = Parser.new.parse(document)
+
+      result.posts.first
+    end
+
+    let(:post_hash) do
+      post.to_h
+    end
+
+    attributes = %i[
+      id
+      author
+      url
+      title
+      text
+      location_code
+      language_code
+      coordinates
+      links
+      tags
+      images
+      indexed_at
+      published_at
+      reindexed_at
+      inlinks_count
+      blog_id
+      blog_name
+      blog_url
+      blog_rank
+      authority
+    ]
+
+    it do
+      expect(post_hash.keys).to match_array(attributes)
+    end
+
+    attributes.each do |key|
+      describe "#to_h[:#{key}]" do
+        subject { post_hash[key] }
+        it { is_expected.to eq(post.public_send(key)) }
+      end
+    end
+  end
 end