roar-extensions 0.0.2

data/lib/roar_extensions/resource_links.rb

@@ -0,0 +1,16 @@
+module RoarExtensions
+  module ResourceLinks
+  private
+    def merge_links(collection, &presenter_generator)
+      collection.inject({}) do |acc, element|
+        acc.merge(presenter_generator.call(element).to_hash)
+      end
+    end
+
+    def resource_link_json(link_hash)
+      link_hash.inject({}) do |acc, (rel, href)|
+        acc.merge(LinkPresenter.new(rel, href).to_hash)
+      end
+    end
+  end
+end

data/lib/roar_extensions/version.rb

@@ -0,0 +1,3 @@
+module RoarExtensions
+  VERSION = "0.0.2"
+end

data/roar-extensions.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/roar_extensions/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Donald Plummer", "Michael Xavier"]
+  gem.email         = ["developers@crystalcommerce.com"]
+  gem.description   = %q{Useful extensions to roar}
+  gem.summary       = %q{Useful extensions to roar}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "roar-extensions"
+  gem.require_paths = ["lib"]
+  gem.version       = RoarExtensions::VERSION
+
+  gem.add_dependency("roar", "0.11.3")
+  gem.add_dependency("activesupport", ">= 2.3.14")
+
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "rake",        "~>0.9.2"
+  gem.add_development_dependency "rspec",       "~>2.10.0"
+  gem.add_development_dependency "guard",       "~>1.2.1"
+  gem.add_development_dependency "guard-rspec", "~>1.1.0"
+end

data/spec/destroyed_record_presenter_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'roar_extensions'
+
+module RoarExtensions
+  describe DestroyedRecordPresenter do
+    class DestroyedRecordPresenterTest
+      include DestroyedRecordPresenter
+      root_element :foo
+    end
+
+    subject { DestroyedRecordPresenterTest.new(123) }
+
+    it "has just the id" do
+      subject.to_hash.should == {'foo' => {'id' => 123}}
+    end
+  end
+end

data/spec/helpers/embedded_parameter_parsing_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'roar_extensions'
+
+module RoarExtensions::Helpers
+  describe EmbeddedParameterParsing do
+    class MyTestController
+      def self.before_filter(*args)
+        # yup
+      end
+    end
+
+    subject { MyTestController.new }
+
+    describe "including into a class" do
+      it "calls before_filter" do
+        MyTestController.should_receive(:before_filter).with(:parse_embedded_params_filter)
+        MyTestController.send(:include, EmbeddedParameterParsing)
+      end
+    end
+
+    describe "parse_embedded_params" do
+      before(:each) do
+        MyTestController.send(:include, EmbeddedParameterParsing)
+      end
+      it "returns empty array for blank string" do
+        subject.parse_embedded_params("").should == []
+      end
+
+      it "returns empty array for nil" do
+        subject.parse_embedded_params(nil).should == []
+      end
+
+      it "returns the given list if comma-separated as symbols" do
+        subject.parse_embedded_params("foo,bar").should == [:foo, :bar]
+      end
+
+      it "recursively parses nested embeddings" do
+        subject.parse_embedded_params("line_items:product,line_items:variant,customer,address:ip_address").should == [
+          :customer,
+          {:line_items => [:product, :variant], :address => [:ip_address]}
+        ]
+      end
+
+      it "recurses multiple levels" do
+        subject.parse_embedded_params("customer,line_items:product:category").should == [
+          :customer,
+          {:line_items => [{:product => [:category]}]}
+        ]
+      end
+    end
+  end
+end

data/spec/link_presenter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'roar_extensions'
+
+module RoarExtensions
+  describe LinkPresenter do
+    subject { LinkPresenter.new('search_engine', 'http://google.com') }
+
+    describe "#==" do
+      it "returns true if href, rel, and title match" do
+        subject.should == LinkPresenter.new('search_engine', 'http://google.com')
+      end
+
+      it "returns false if href, rel, or title differ" do
+        subject.should_not == LinkPresenter.new('search_engine', 'http://bing.com')
+        subject.should_not == LinkPresenter.new('weee', 'http://google.com')
+        subject.should_not == LinkPresenter.new('search_engine', 'http://google.com', 'cows')
+      end
+    end
+
+    context "no title" do
+      its(:as_json) do
+        should == { 'search_engine' => {:href => 'http://google.com'} }
+      end
+
+      it "aliases to_hash to as_json" do
+        subject.to_hash.should == subject.as_json
+      end
+    end
+
+    context "title given" do
+      subject { LinkPresenter.new('search_engine',
+                                           'http://google.com',
+                                           'Cool Search') }
+      its(:as_json) do
+        should == {
+          'search_engine' => {
+            :href  => 'http://google.com',
+            :title => 'Cool Search'
+          }
+        }
+      end
+
+      it "aliases to_hash to as_json" do
+        subject.to_hash.should == subject.as_json
+      end
+    end
+  end
+end

data/spec/money_presenter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'roar_extensions'
+
+module RoarExtensions
+  describe MoneyPresenter do
+    let(:currency) { stub(:iso_code => "USD") }
+    let(:money)    { stub(:currency => currency, :cents => 100) }
+
+    subject { MoneyPresenter.new(money) }
+
+    it "has cents" do
+      subject.to_hash['money']['cents'].should == 100
+    end
+
+    it "has currency" do
+      subject.to_hash['money']['currency'].should == "USD"
+    end
+  end
+end

data/spec/paginated_collection_presenter_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+require "roar_extensions"
+
+module RoarExtensions
+  describe PaginatedCollectionPresenter do
+    class TestEntry
+      include RoarExtensions::Presenter
+
+      attr_reader :name, :age
+
+      def initialize(name, age)
+        @name = name
+        @age = age
+      end
+
+      property :name
+      property :age
+      property :lowercased_name, :from => :name_downcase
+
+      def name_downcase
+        name.downcase
+      end
+
+    end
+
+    let(:current_page)  { 1 }
+    let(:next_page)     { 2 }
+    let(:previous_page) { nil }
+    let(:entries) {[
+      TestEntry.new("Bob", 41)
+    ]}
+    let(:paginated_result) do
+      mock("Paginated Result", :total_pages   => 3,
+                               :current_page  => current_page,
+                               :next_page     => next_page,
+                               :previous_page => previous_page,
+                               :total_entries => 3,
+                               :collect       => entries,
+                               :per_page      => 1)
+    end
+    let(:base_path) { "/things" }
+    let(:json_options) {{}}
+
+    describe "#to_hash" do
+      let(:presenter)  { PaginatedCollectionPresenter.new(paginated_result,
+                                                          base_path)}
+      subject { JSON.parse(presenter.to_json(json_options))['paginated_collection'] }
+
+      it "includes the total pages" do
+        subject['total_pages'].should == 3
+      end
+
+      it "includes the total entries" do
+        subject['total_entries'].should == 3
+      end
+
+      it "includes the per page" do
+        subject['per_page'].should == 1
+      end
+
+      it "includes the self link" do
+        subject['_links']['self'].should == {"href" => "/things"}
+      end
+
+      it "includes the next_page link" do
+        subject['_links']['next_page'].should == {"href" => "/things?page=2"}
+      end
+
+      it "does not include the previous_page link on the first page" do
+        subject['_links'].should_not have_key('previous_page')
+      end
+
+      it "includes the paginated results under the entries key" do
+        subject['entries'].should == [{'name' => 'Bob',
+                                       'age' => 41,
+                                       'lowercased_name' => 'bob'}]
+      end
+
+      it "includes current_page" do
+        subject["current_page"].should == 1
+      end
+
+      it "includes next_page" do
+        subject["next_page"].should == 2
+      end
+
+      it "includes previous_page" do
+        subject["previous_page"].should == nil
+      end
+
+      context "on last page" do
+        let(:previous_page) { 2 }
+        let(:current_page)  { 3 }
+        let(:next_page)     { nil }
+
+        it "includes the self link" do
+          subject['_links']['self'].should == {"href" => "/things?page=3"}
+        end
+
+        it "does not include the next_page link" do
+          subject['_links'].should_not have_key('next_page')
+        end
+
+        it "includes the previous_page link" do
+          subject['_links']['previous_page'].should == {"href" => "/things?page=2"}
+        end
+
+        it "includes current_page" do
+          subject["current_page"].should == 3
+        end
+
+        it "includes next_page" do
+          subject["next_page"].should == nil
+        end
+
+        it "includes previous_page" do
+          subject["previous_page"].should == 2
+        end
+      end
+
+      context "middle page" do
+        let(:previous_page) { 1 }
+        let(:current_page)  { 2 }
+        let(:next_page)     { 3 }
+
+        it "includes the self link" do
+          subject['_links']['self'].should == {"href" => "/things?page=2"}
+        end
+
+        it "includes the next_page link" do
+          subject['_links']['next_page'].should == {"href" => "/things?page=3"}
+        end
+
+        it "includes the previous_page link" do
+          subject['_links']['previous_page'].should == {"href" => "/things"}
+        end
+
+        it "includes current_page" do
+          subject["current_page"].should == 2
+        end
+
+        it "includes next_page" do
+          subject["next_page"].should == 3
+        end
+
+        it "includes previous_page" do
+          subject["previous_page"].should == 1
+        end
+      end
+
+      context "attribute whitelisting" do
+        let(:json_options) {{:include => [:name]}}
+
+        it "the include option is passed to the entries" do
+          subject['entries'].should == [{'name' => 'Bob'}]
+        end
+
+        context "using the :from property option" do
+          let(:json_options) {{:include => ["lowercased_name"]}}
+
+          it "the include option is passed to the entries" do
+            subject['entries'].should == [{'lowercased_name' => 'bob'}]
+          end
+        end
+      end
+
+      context "attribute blacklisting" do
+        let(:json_options) {{:exclude => [:name]}}
+
+        it "the include option is passed to the entries" do
+          subject['entries'].should == [{'age' => 41, 'lowercased_name' => 'bob'}]
+        end
+      end
+    end
+  end
+end

data/spec/presenter_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+require 'roar_extensions'
+
+module RoarExtensions
+  describe Presenter do
+
+    class TestPhotoPresenter
+      include Presenter
+
+      root_element :photo
+
+      delegated_property :position
+    end
+
+    class TestProductPresenter
+      include Presenter
+
+      root_element :product
+
+      delegated_property :id,             :always_include => true
+      delegated_property :name
+      delegated_property :is_buying,      :from => :buying?
+      delegated_property :msrp,           :as => MoneyPresenter
+      property :possible_variants_count
+      property :min_sell_price,           :as => MoneyPresenter
+      property :catalog_links,            :from => :catalog_links_as_json
+      delegated_collection :photos,       :as => TestPhotoPresenter, :embedded => true
+
+      link(:rel => "self")             { "/v1/products/#{record.id}" }
+      link(:rel => "category")         { "/v1/categories/#{record.category_id}" }
+      link(:rel => "related_products") { "/v1/products/#{record.id}/related" }
+
+      def initialize(record, options = {})
+        super(record)
+
+        @embedded = options.fetch(:embedded, [])
+      end
+
+      private
+
+      def min_sell_price
+        OpenStruct.new(:cents => 499,
+                       :currency => OpenStruct.new(:iso_code => 'USD'))
+      end
+
+      def possible_variants_count
+        3
+      end
+
+      def catalog_links_as_json
+        {'omg' => 'wtf'}
+      end
+    end
+
+    let(:product) {
+      mock("Product Record",
+           :id          => 9001,
+           :category_id => 800,
+           :name        => "Worship",
+           :photos      => [photo],
+           :msrp        => stub(:cents => 300, :currency => stub(:iso_code => 'USD')),
+           :buying?     => true)
+    }
+    
+    let(:photo) {
+      mock("Photo", :position => 1)
+    }
+
+    let(:options) { {} }
+    let(:json_options) { {} }
+
+    let(:presenter) {  TestProductPresenter.new(product, options) }
+
+    subject { presenter }
+
+    it "aliases to_hash to as_json" do
+      subject.to_hash.should == subject.as_json
+    end
+
+    context "as_json" do
+      subject { presenter.as_json(json_options)['product'] }
+
+      it "has a name" do
+        subject['name'].should == 'Worship'
+      end
+
+      it "has a possible_variants_count" do
+        subject['possible_variants_count'].should == 3
+      end
+
+      it "has a catalog_links" do
+        subject['catalog_links'].should == {'omg' => 'wtf'}
+      end
+
+      it "has an msrp as money" do
+        subject['msrp'].should == {
+          'money' => {
+            'cents'    => 300,
+            'currency' => 'USD'
+          }
+        }
+      end
+
+      it "has a min sell price as money" do
+        subject['min_sell_price'].should == {
+          'money' => {
+            'cents'    => 499,
+            'currency' => 'USD'
+          }
+        }
+      end
+
+      it "has an id" do
+        subject['id'].should == 9001
+      end
+
+      it "has the buyingness" do
+        subject['is_buying'].should == true
+      end
+
+
+      it "has api _links" do
+        subject['_links'].should == {
+          'self' => { :href => "/v1/products/9001" },
+          'related_products' => { :href => "/v1/products/9001/related" },
+          'category' => { :href => '/v1/categories/800'}
+        }
+      end
+
+      it "does not embed" do
+        subject.should_not have_key('_embedded')
+      end
+
+      context "embedding of photos enabled" do
+        let(:options) { {:embedded => [:photos]} }
+
+        it "has embedded photos" do
+          subject['_embedded']['photos'].should == [
+            {
+              'photo' => {
+                'position' => 1
+              }
+            }
+          ]
+        end
+      end
+
+      context "always renders nil attributes" do
+        before(:each) do
+          product.stub(:name).and_return(nil)
+        end
+
+        it "has a null name" do
+          subject.fetch('name').should == nil
+        end
+      end
+
+      context "limiting attributes returned" do
+        let(:json_options) {{ :include => [:name] }}
+
+        it "limits to the attributes requested, plus required attributes" do
+          subject.keys.should == ['id', 'name']
+        end
+      end
+    end
+  end
+end