pipe_line_dealer 0.1.0

data/spec/custom_fields_spec.rb

@@ -0,0 +1,114 @@
+require "helper"
+
+describe PipeLineDealer::CustomFields do
+  before { pending "TODO" }
+  include ConnectionHelper
+
+  class ModelWithCustomFields < PLD::Model::Base
+    @collection_url       = "models"
+    @model_attribute_name = "model"
+    @custom_field_client_method = :model_custom_fields
+
+    attrs :name
+
+    include PLD::CustomFields
+  end
+
+  class CustomModelField < PipeLineDealer::CustomField
+    @collection_url = "admin/model_custom_field_labels"
+  end
+
+  let(:collection) { PLD::Collection.new(client, klass: ModelWithCustomFields) }
+
+  let(:custom_attributes) { {
+    "custom_label_90" => 42,
+    "custom_label_91" => "Yeah"
+  } }
+
+  let(:custom_field_labels) { {
+     "entries"=>[
+        {
+          "id"=>90,
+          "name"=>"TheAnswerForEverything",
+          "is_required"=>false,
+          "field_type"=>"numeric"
+        },
+        {
+          "id"=>91,
+          "name"=>"Really?",
+          "is_required"=>false,
+          "field_type"=>"text"
+        }
+     ],
+     "pagination" => {"page" => 1, "pages" => 1, "per_page" => 2, "total" => 2}
+    }
+  }
+
+  subject { ModelWithCustomFields.new(collection: collection, persisted: true, attributes: { "id" => 123, name: "Springest", custom_fields: custom_attributes} ) }
+
+  context "reading custom fields" do
+    before { client.stub(:model_custom_fields).and_return { PLD::CustomField::Collection.new(client, klass: CustomModelField, cache_key: :custom_field_cache_key) } }
+
+    let(:custom_field_models) do
+       custom_field_labels.collect { |label| CustomModelField.new(collection: model_custom_fields, persisted: true, attributes: label) }
+    end
+
+    it "fetches the translation map" do
+      pending
+#      connection.should_receive(:get).once.with("admin/model_custom_field_labels.json", anything()).and_return(custom_field_labels)
+      connection.should_receive(:cache).once.with(:custom_field_cache_key).and_return(custom_field_labels)
+      subject.custom_fields
+    end
+
+   it "translates the custom fields to recognizable labels" do
+      connection.should_receive(:get).once.with("admin/model_custom_field_labels.json", anything()).and_return(custom_field_labels)
+
+      subject.custom_fields.should == {
+        "TheAnswerForEverything" => 42,
+        "Really?" => "Yeah"
+      }
+    end
+  end
+
+  context "storing" do
+    before { client.stub(:model_custom_fields).and_return { PLD::CustomField::Collection.new(client, klass: CustomModelField) } }
+
+    it "reposts the correct attributes" do
+      expected_attributes = {
+        "model" => {
+          "name" => "Springest",
+          "custom_fields" => custom_attributes
+         }
+      }
+
+      # TODO: should do this only once!
+      connection.should_receive(:get).exactly(4).times.with("admin/model_custom_field_labels.json", anything()).and_return(custom_field_labels)
+      connection.should_receive(:put).once.with("models/123.json", expected_attributes)
+
+      subject.save
+    end
+
+    let(:updated_custom_attributes) { {
+      "custom_label_90" => 43,
+      "custom_label_91" => "Whoo"
+    } }
+
+    it "posts the correct change" do
+      expected_attributes = {
+        "model" => {
+          "name" => "Springest",
+          "custom_fields" => updated_custom_attributes
+         }
+      }
+
+      # TODO: should do this only once!
+      connection.should_receive(:get).exactly(4).times.with("admin/model_custom_field_labels.json", anything()).and_return(custom_field_labels)
+      connection.should_receive(:put).once.with("models/123.json", expected_attributes)
+
+
+      subject.custom_fields["TheAnswerForEverything"] = 43
+      subject.custom_fields["Really?"] = "Whoo"
+      subject.save
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,32 @@
+Bundler.setup
+
+unless ENV["NO_COVERAGE"]
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "spec"
+  end
+end
+
+require "pipe_line_dealer"
+require "webmock/rspec"
+require "reek/spec"
+
+# Load support files
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+
+  # Do not run the acceptance tests by default.
+  if ENV["ACCEPTANCE"] == "true"
+    puts "Running acceptance specs!"
+    AcceptanceHelper.check_api_key!
+  else
+    puts "Skipping acceptance specs"
+    config.filter_run_excluding acceptance: true
+  end
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.include Reek::Spec
+end

data/spec/models/base/concern/persistance_spec.rb

@@ -0,0 +1,55 @@
+require "helper"
+
+describe PipeLineDealer::Model::Base::Concern::Persistance do
+  include CollectionHelper
+
+  context "routing (url&method)" do
+    context "non persisted models" do
+      context "build by collection" do
+        subject { collection.new }
+
+        it "builds a non persisted model" do
+          subject.persisted?.should == false
+        end
+
+        it "builds a non persisted model" do
+          subject.persisted?.should == false
+        end
+      end
+
+      context "when saved" do
+        subject { collection.new(name: "Springest") }
+        after(:each) { subject.save }
+
+        it "uses the POST method" do
+          connection.should_receive(:post).and_return([200, {}])
+        end
+
+        it "posts to the correct address" do
+          connection.should_receive(:post).with("test_models.json", anything).and_return([200, {}])
+        end
+
+        it "posts the correct attributes" do
+          connection.should_receive(:post).with(anything, "moeha" => { "name" => "Springest" }).and_return([200, {}])
+        end
+      end
+    end
+
+    context "persisted models" do
+      subject { TestModel.new(collection: collection, persisted: true, attributes: { "id" => 123, name: "Springest"} ) }
+      after(:each) { subject.save }
+
+      it "uses the PUT method" do
+        connection.should_receive(:put).and_return([200, {}])
+      end
+
+      it "posts to the correct address" do
+        connection.should_receive(:put).with("test_models/123.json", anything).and_return([200, {}])
+      end
+
+      it "posts the correct attributes" do
+        connection.should_receive(:put).with(anything, "moeha" => { "name" => "Springest" }).and_return([200, {}])
+      end
+    end
+  end
+end

data/spec/models/base_spec.rb

@@ -0,0 +1,32 @@
+require "helper"
+
+describe PLD::Model::Base do
+  subject { TestModel }
+
+  context "initialization" do
+    let(:model) { subject.new(attributes: {name: "Springest"}) }
+
+    it "can access the name by the name method" do
+      model.name.should == "Springest"
+    end
+
+    it "can access the name by via attributes['name']" do
+      model.attributes['name'].should == "Springest"
+    end
+
+    it "can access the name by via attributes[:name]" do
+      model.attributes[:name].should == "Springest"
+    end
+  end
+
+  context "setting attributes" do
+    let(:model) { subject.new() }
+    context "name is set using accessor" do
+      before { model.name = "Springest" }
+
+      it "is readable via the accessor" do
+        model.name.should == "Springest"
+      end
+    end
+  end
+end

data/spec/models/custom_field_spec.rb

@@ -0,0 +1,127 @@
+require "helper"
+
+module PipeLineDealer
+  describe CustomField do
+    let(:model) { nil }
+
+    describe "decode" do
+      context "numeric" do
+        before { subject.field_type = "numeric" }
+
+        it "decodes correctly" do
+          subject.decode(model, 123).should == 123
+        end
+      end
+
+      context "text" do
+        before { subject.field_type = "text" }
+
+        it "decodes correctly" do
+          subject.decode(model, "Moehaha").should == "Moehaha"
+        end
+      end
+
+      context "currency" do
+        before { subject.field_type = "currency" }
+
+        it "decodes correctly" do
+          subject.decode(model, 42).should == 42
+        end
+      end
+
+      context "dropdown" do
+        subject do
+          CustomField.new(attributes: {
+            "field_type" => "dropdown",
+            "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+          })
+        end
+
+        it "decodes correctly" do
+          subject.decode(model, 123).should == "My Item"
+        end
+      end
+
+      context "multi_select" do
+        subject do
+          CustomField.new(attributes: {
+            "field_type" => "multi_select",
+            "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+          })
+        end
+
+        it "decodes correctly" do
+          subject.decode(model, [123]).should == ["My Item"]
+        end
+      end
+
+      context "Unkown type" do
+        before { subject.field_type = "not-known" }
+
+        it "throws an exception" do
+          expect { subject.decode(model, 42) }.to raise_error
+        end
+      end
+    end
+
+    describe "encode" do
+      context "numeric" do
+        before { subject.field_type = "numeric" }
+
+        it "encodes correctly" do
+          subject.encode(model, 123).should == 123
+        end
+      end
+
+      context "text" do
+        before { subject.field_type = "text" }
+
+        it "encodes correctly" do
+          subject.encode(model, "Moehaha").should == "Moehaha"
+        end
+      end
+
+      context "currency" do
+        before { subject.field_type = "currency" }
+
+        it "encodes correctly" do
+          subject.encode(model, 42).should == 42
+        end
+      end
+
+      context "dropdown" do
+        subject do
+          CustomField.new(attributes: {
+            "field_type" => "dropdown",
+            "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+          })
+        end
+
+        it "encodes correctly" do
+          subject.encode(model, "My Item").should == 123
+        end
+      end
+
+      context "multi_select" do
+        subject do
+          CustomField.new(attributes: {
+            "field_type" => "multi_select",
+            "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+          })
+        end
+
+        it "encodes correctly" do
+          subject.encode(model, ["My Item"]).should == [123]
+        end
+      end
+
+      context "Unkown type" do
+        before { subject.field_type = "not-known" }
+
+        it "throws an exception" do
+          expect { subject.encode(model, 42) }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/smell_spec.rb

@@ -0,0 +1,6 @@
+describe "The source of this gem" do
+  it "contains no code smells" do
+    pending "Will move there, but not yet."
+    Dir["lib/**/*.rb"].should_not reek
+  end
+end

data/spec/support/acceptance_helper.rb

@@ -0,0 +1,39 @@
+module AcceptanceHelper extend ActiveSupport::Concern
+
+  class << self
+    KEY_FILE = File.expand_path("../../api.key", __FILE__)
+
+    def check_api_key!
+      if not find_api_key
+        puts
+        $stderr.puts "No API key found to run the acceptance tests!"
+        puts "To specify a API key, either:"
+        puts " 1) use the API_KEY environmental variable!"
+        puts " 2) create a 'spec/api.key' file which contains the API key."
+        puts
+        exit(1)
+      end
+    end
+
+    def find_api_key
+      ENV["API_KEY"] || File.exists?(KEY_FILE) && File.read(KEY_FILE).chomp.strip
+    end
+  end
+
+  included do
+    let(:api_key) { AcceptanceHelper.find_api_key }
+    let(:client) { PLD::Client.new(AcceptanceHelper.find_api_key) }
+
+    around do |example|
+      if example.metadata.has_key? :acceptance
+        WebMock.allow_net_connect!
+
+        PLDCleaner.clean!(client)
+      end
+
+      example.run
+
+      WebMock.disable_net_connect! if example.metadata.has_key? :acceptance
+    end
+  end
+end

data/spec/support/collection_helper.rb

@@ -0,0 +1,8 @@
+module CollectionHelper
+  extend ActiveSupport::Concern
+
+  included do
+    include ConnectionHelper
+    let(:collection) { PLD::Collection.new(client, klass: TestModel) }
+  end
+end

data/spec/support/connection_helper.rb

@@ -0,0 +1,9 @@
+module ConnectionHelper
+  extend ActiveSupport::Concern
+
+  included do
+    let(:connection) { double("Connection") }
+    let(:client) { double("Client") }
+    before { client.stub(:connection).and_return(connection) }
+  end
+end

data/spec/support/pld_cleaner.rb

@@ -0,0 +1,16 @@
+module PLDCleaner
+  extend self
+
+  COLLECTION_NAMES = [:companies, :people]
+
+  def clean!(client)
+    COLLECTION_NAMES.each do |collection_name|
+      collection = client.send(collection_name)
+
+      collection.each do |model|
+        #CRITICAL
+        model.destroy || raise("Could not remove #{model.inspect}")
+      end
+    end
+  end
+end

data/spec/support/test_model.rb

@@ -0,0 +1,6 @@
+class TestModel < PLD::Model::Base
+  @collection_url = "test_models"
+  @model_attribute_name = "moeha"
+
+  attrs :name
+end

data/todo.txt

@@ -0,0 +1,6 @@
+- test coverage to 100%
+- specs for not saving some attributes
+- implement other models
+
+WRITE SPECS FOR:
+- lib/pipe_line_dealer/model/custom_field.rb