mavenlink-ruby 0.0.2

data/spec/lib/mavenlink/resources/custom_field_value_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe Mavenlink::CustomFieldValue do
+  describe ".list" do
+    context "a subject type is provided" do
+      it "should be listable", :vcr do
+        custom_field_values = Mavenlink::CustomFieldValue.list("workspace_group")
+        expect(
+          a_request(:get, "#{Mavenlink.api_base}/custom_field_values")
+          .with(query: { subject_type: "workspace_group" })
+        ).to have_been_made
+        expect(custom_field_values.data).to be_a Array
+        expect(custom_field_values.first).to be_a Mavenlink::CustomFieldValue
+      end
+    end
+
+    context "no subject type is provided" do
+      it "should raise an error" do
+        expect do
+          Mavenlink::CustomFieldValue.list
+        end.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe ".retrieve" do
+    it "should be retrievable", :vcr do
+      custom_field_value = Mavenlink::CustomFieldValue.retrieve("314259865")
+
+      expect(a_request(:get, "#{Mavenlink.api_base}/custom_field_values/314259865")).to(
+        have_been_made
+      )
+      expect(custom_field_value).to be_a Mavenlink::CustomFieldValue
+    end
+  end
+
+  describe "#subject" do
+    let(:custom_field_value_attrs) do
+      {
+        "subject_type": "workspace_group",
+        "subject_id": 2223265,
+        "value": "ABCD",
+        "account_id": 6300575,
+        "custom_field_name": "Stripe ID",
+        "type": "string",
+        "display_value": "ABCD",
+        "can_edit": true,
+        "created_at": "2020-01-02T12:30:06-08:00",
+        "updated_at": "2020-01-02T12:30:06-08:00",
+        "custom_field_id": "602325",
+        "setter_id": "12304555",
+        "id": "314259865",
+      }
+    end
+
+    before do
+      allow(Mavenlink::WorkspaceGroup).to receive(:retrieve).with(2_223_265) do
+        Mavenlink::WorkspaceGroup.new(id: 2_223_265)
+      end
+    end
+    it "should retrieve the subject from the relevant class" do
+      custom_field_value =  Mavenlink::CustomFieldValue.new(custom_field_value_attrs)
+      custom_field_value.subject
+      expect(Mavenlink::WorkspaceGroup).to have_received(:retrieve)
+    end
+  end
+end

data/spec/lib/mavenlink/resources/invoice_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe Mavenlink::Invoice, type: :model do
+  it "should be retrievable", :vcr do
+    invoice = Mavenlink::Invoice.retrieve("8185325")
+
+    expect(a_request(:get, "#{Mavenlink.api_base}/invoices/8185325")).to(
+      have_been_made
+    )
+    expect(invoice).to be_a Mavenlink::Invoice
+  end
+
+  it "should be listable", :vcr do
+    invoices = Mavenlink::Invoice.list
+    expect(a_request(:get, "#{Mavenlink.api_base}/invoices")).to have_been_made
+    expect(invoices).to be_a Mavenlink::List
+    expect(invoices.first).to be_a Mavenlink::Invoice
+  end
+
+  it "should be creatable", :vcr do
+    invoice = Mavenlink::Invoice.create(
+      additional_items: [
+        notes: "",
+        amount: 250,
+        taxable: false,
+        workspace_id: 28370425,
+      ],
+      workspace_id: 28370425,
+      payment_schedule: 30,
+      draft: false,
+      supress_emails: true
+    )
+    expect(a_request(:post, "#{Mavenlink.api_base}/invoices")).to have_been_made
+    expect(invoice).to be_a Mavenlink::Invoice
+  end
+end

data/spec/lib/mavenlink/resources/workspace_group_spec.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe Mavenlink::WorkspaceGroup do
+  describe ".retrieve" do
+    it "should be retrievable", :vcr do
+      workspace_group = Mavenlink::WorkspaceGroup.retrieve("2551145")
+
+      expect(a_request(:get, "#{Mavenlink.api_base}/workspace_groups/2551145")).to(
+        have_been_made
+      )
+      expect(workspace_group).to be_a Mavenlink::WorkspaceGroup
+    end
+  end
+
+  describe ".list" do
+    it "should be listable", :vcr do
+      workspace_groups = Mavenlink::WorkspaceGroup.list
+      expect(a_request(:get, "#{Mavenlink.api_base}/workspace_groups")).to have_been_made
+      expect(workspace_groups).to be_a Mavenlink::List
+      expect(workspace_groups.first).to be_a Mavenlink::WorkspaceGroup
+    end
+  end
+
+  describe ".list_workspaces" do
+    it "should list the Workspaces for the provided WorkspaceGroup id", :vcr do
+      workspaces = Mavenlink::WorkspaceGroup.list_workspaces(2551145)
+      expect(a_request(:get, "#{Mavenlink.api_base}/workspaces")
+                       .with(query: { workspace_groups: 2551145 })).to have_been_made
+      expect(workspaces).to be_a Mavenlink::List
+      expect(workspaces.to_a.first).to be_a Mavenlink::Workspace
+    end
+  end
+
+  describe ".list_custom_field_values" do
+    # Setup a fake custom_field_values response that contains two values for
+    # our object and two for other objects.
+    # We can't rely on VCR here because we're trying to setup a specific
+    # scenario in the *response* and the real-world values could change at
+    # any time
+    # TODO: Probably move this to a factory / fixture file.
+
+    before do
+      # Numeric Literals just look weird in IDs
+      stub_request(:get, "#{Mavenlink.api_base}/custom_field_values")
+        .with(query: { subject_type: "workspace_group" })
+        .to_return(
+          headers: {
+            "Content-Type": "application/json",
+          },
+          body: JSON.generate(
+            count: 4,
+            results: [
+              { key: "custom_field_values", id: "111" },
+              { key: "custom_field_values", id: "222" },
+              { key: "custom_field_values", id: "888" },
+              { key: "custom_field_values", id: "999" },
+            ],
+            custom_field_values: {
+              "111": { id: "111",
+                       subject_type: "workspace_group", subject_id: 2551145,
+                       custom_field_name: "Foo", value: "Bar", },
+              "222": { id: "222",
+                       subject_type: "workspace_group", subject_id: 2551145,
+                       custom_field_name: "Stripe ID", value: "cus_xyz", },
+              "888": { id: "888",
+                       subject_type: "workspace_group", subject_id: 9999999,
+                       custom_field_name: "Bar", value: "I'm having the muffin", },
+              "999": { id: "999",
+                       subject_type: "workspace_group", subject_id: 9999999,
+                       custom_field_name: "Stripe ID", value: "cus_xyz", },
+            },
+            meta: {
+              count: 4,
+              page_count: 1,
+              page_number: 1,
+              page_size: 20,
+            }
+          )
+        )
+    end
+
+    let!(:custom_field_values) { Mavenlink::WorkspaceGroup.list_custom_field_values(2551145) }
+    it "should list CustomFieldValues" do
+      expect(
+        a_request(:get, "#{Mavenlink.api_base}/custom_field_values")
+        .with(query: { subject_type: "workspace_group" })
+      ).to have_been_made
+      expect(custom_field_values).to be_a Mavenlink::List
+      expect(custom_field_values.to_a.first).to be_a Mavenlink::CustomFieldValue
+    end
+
+    it "should only return the CustomFieldValues for the current object" do
+      expect(custom_field_values.count).to eq 2
+    end
+  end
+
+  describe "#workspaces" do
+    before do
+      allow(Mavenlink::WorkspaceGroup).to receive(:list_workspaces).and_return(true)
+    end
+    let(:workspace_group) { Mavenlink::WorkspaceGroup.new(id: 2551145) }
+
+    it "should defer to .list_workspaces with the current id" do
+      allow(Mavenlink::WorkspaceGroup).to receive :list_workspaces
+      workspace_group = Mavenlink::WorkspaceGroup.new(id: 2551145)
+
+      workspace_group.workspaces
+
+      expect(Mavenlink::WorkspaceGroup).to(
+        have_received(:list_workspaces).with(2551145)
+      )
+    end
+
+    it "should cache the result and not call list_workspaces twice" do
+      workspace_group.workspaces
+      workspace_group.workspaces
+
+      expect(Mavenlink::WorkspaceGroup).to(
+        have_received(:list_workspaces).with(2551145).once
+      )
+    end
+  end
+
+  describe "#custom_field_values", :vcr do
+    before do
+      allow(Mavenlink::WorkspaceGroup).to receive(:list_custom_field_values).and_return true
+    end
+
+    let(:workspace_group) { Mavenlink::WorkspaceGroup.new(id: 2551145) }
+    it "should defer to .list_custom_field_values with the current id" do
+      workspace_group.custom_field_values
+
+      expect(Mavenlink::WorkspaceGroup).to have_received(:list_custom_field_values).with(2551145)
+    end
+
+    it "should cache the result and not call list_custom_field_values twice" do
+      workspace_group.custom_field_values
+      workspace_group.custom_field_values
+
+      expect(Mavenlink::WorkspaceGroup).to(
+        have_received(:list_custom_field_values).with(2551145).once
+      )
+    end
+  end
+end

data/spec/lib/mavenlink/resources/workspace_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+
+RSpec.describe Mavenlink::Workspace do
+  describe ".retrieve" do
+    it "should be retrievable", :vcr do
+      workspace = Mavenlink::Workspace.retrieve("28370425")
+
+      expect(a_request(:get, "#{Mavenlink.api_base}/workspaces/28370425")).to(
+        have_been_made
+      )
+      expect(workspace).to be_a Mavenlink::Workspace
+    end
+  end
+
+  describe ".list" do
+    it "should be listable", :vcr do
+      workspaces = Mavenlink::Workspace.list
+      expect(a_request(:get, "#{Mavenlink.api_base}/workspaces")).to have_been_made
+      expect(workspaces).to be_a Mavenlink::List
+      expect(workspaces.first).to be_a Mavenlink::Workspace
+    end
+  end
+
+  describe ".list_invoices" do
+    it "should list the Invoices for the provided Workspace id", :vcr do
+      invoices = Mavenlink::Workspace.list_invoices(28370425)
+      expect(a_request(:get, "#{Mavenlink.api_base}/invoices")
+                       .with(query: { workspace_id: 28370425 })).to have_been_made
+      expect(invoices).to be_a Mavenlink::List
+      expect(invoices.to_a.first).to be_a Mavenlink::Invoice
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# require "simplecov"
+# SimpleCov.start
+
+require "dotenv/load"
+require "mavenlink"
+require "rspec"
+require "webmock/rspec"
+require "vcr"
+
+require_relative "../lib/mavenlink"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "fixtures/vcr_cassettes"
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Mavenlink.api_key = ENV["MAVENLINK_API_KEY"]
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mavenlink-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Adam Dawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-15 00:00:00.000000000 Z
+dependencies: []
+description: Inspired by Stripe's stripe-ruby
+email: adam@dragondrop.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fixtures/vcr_cassettes/Mavenlink_CustomFieldValue/_list/a_subject_type_is_provided/should_be_listable.yml
+- fixtures/vcr_cassettes/Mavenlink_CustomFieldValue/_retrieve/should_be_retrievable.yml
+- fixtures/vcr_cassettes/Mavenlink_Invoice/_list/should_be_listable.yml
+- fixtures/vcr_cassettes/Mavenlink_Invoice/_retrieve/should_be_retrievable.yml
+- fixtures/vcr_cassettes/Mavenlink_Workspace/_list/should_be_listable.yml
+- fixtures/vcr_cassettes/Mavenlink_Workspace/_list_invoices/should_list_the_Invoices_for_the_provided_Workspace_id.yml
+- fixtures/vcr_cassettes/Mavenlink_Workspace/_retrieve/should_be_retrievable.yml
+- fixtures/vcr_cassettes/Mavenlink_WorkspaceGroup/_list/should_be_listable.yml
+- fixtures/vcr_cassettes/Mavenlink_WorkspaceGroup/_list_workspaces/should_list_the_Workspaces_for_the_provided_WorkspaceGroup_id.yml
+- fixtures/vcr_cassettes/Mavenlink_WorkspaceGroup/_retrieve/should_be_retrievable.yml
+- lib/mavenlink.rb
+- lib/mavenlink/api_operations/request.rb
+- lib/mavenlink/api_resource.rb
+- lib/mavenlink/list.rb
+- lib/mavenlink/resources.rb
+- lib/mavenlink/resources/custom_field_value.rb
+- lib/mavenlink/resources/invoice.rb
+- lib/mavenlink/resources/workspace.rb
+- lib/mavenlink/resources/workspace_group.rb
+- lib/mavenlink/util.rb
+- mavenlink-ruby.gemspec
+- spec/.rubocop.yml
+- spec/lib/mavenlink/list_spec.rb
+- spec/lib/mavenlink/resources/custom_field_value_spec.rb
+- spec/lib/mavenlink/resources/invoice_spec.rb
+- spec/lib/mavenlink/resources/workspace_group_spec.rb
+- spec/lib/mavenlink/resources/workspace_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/mavenlink-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby Mavenlink API Wrapper
+test_files: []