brainstem-adaptor 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6746d8612cec0a387c002ad99c0a75615ef2c00c
-  data.tar.gz: f9cc76d40aaa1bc0fc53461f6caa7e6e34bbfc68
+SHA256:
+  metadata.gz: 0510a423223a9044e50d7233a1a9ac806e2608c207fc433b58bd06ca4cb1378f
+  data.tar.gz: a7577a5628c351ac34cc3e74f0f3338a271e4906d4c5f1ec0216bdf6dcaf743c
 SHA512:
-  metadata.gz: fa62456fbccacbaa9236b7174acef004b4fdf101a85048432498d802bcf54b4910df7a11306de996467b5e5458ca284dd6d059929b3dc8a5cfc4396158940753
-  data.tar.gz: 09887da73e019a9b9ab8bc9b7f2a10b270ca780dcf3aede4cca0be0f2951907106e995eeeb1acb23c1f86ba448505fbe0db72863ab419b1decea0e44b7e65534
+  metadata.gz: 593cc4ecc3ff7e99be5229a47c4cd94586b50622e42fc9dc567e45ab41cb0beaa92a0fb1e066c771736196a25ffda23cd2cb3be1f400fba8b830e1866e4b9bdd
+  data.tar.gz: e8dc4dc4e62f9a985e7fae69eac224ed6bc888aa479dcaf2ea6dcc4cdd012bb071bbae750486a66f7eddf0654287d40418f4f4445190f737573a4cb484070466

data/README.md

@@ -1,6 +1,7 @@
 ## Ruby Brainstem Adaptor
 [![Build Status](https://travis-ci.org/einzige/brainstem-adaptor.svg?branch=master)](https://travis-ci.org/einzige/brainstem-adaptor)
 [![Dependency Status](https://gemnasium.com/einzige/brainstem-ruby.svg)](https://gemnasium.com/einzige/brainstem-ruby)
+[![Gem Version](https://badge.fury.io/rb/brainstem-adaptor.svg)](http://badge.fury.io/rb/brainstem-adaptor)
 
 Brainstem Adaptor provides an easy to use interface for [Brainstem](https://github.com/mavenlink/brainstem) API.
 
@@ -95,4 +96,4 @@ response = BrainstemAdaptor::Response.new(response_data, BrainstemAdaptor::Speci
 
 ## License
 
-Brainstem Adaptor was created by Mavenlink, Inc. and are available under the MIT License.
+Brainstem Adaptor was created by Mavenlink, Inc. and available under the MIT License.

data/brainstem-adaptor.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{brainstem-adaptor}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.date = %q{2014-03-10}
-  s.authors = ["Sergei Zinin (einzige)"]
-  s.email = %q{szinin@gmail.com}
-  s.homepage = %q{http://github.com/einzige/brainstem-adaptor}
+  s.authors = ["Mavenlink", "Sergei Zinin (einzige)"]
+  s.email = ["opensource@mavenlink.com", "szinin@gmail.com"]
+  s.homepage = %q{https://github.com/mavenlink/brainstem-adaptor}
 
   s.licenses = ["MIT"]
 

data/lib/brainstem-adaptor.rb

@@ -7,10 +7,11 @@ require 'brainstem_adaptor/specification'
 require 'brainstem_adaptor/association'
 require 'brainstem_adaptor/record'
 require 'brainstem_adaptor/invalid_response_error'
+require 'brainstem_adaptor/parsers/array_parser'
 require 'brainstem_adaptor/response'
 
 module BrainstemAdaptor
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   def self.parser
     @parser ||= JSON

data/lib/brainstem_adaptor/parsers/array_parser.rb

@@ -0,0 +1,24 @@
+module BrainstemAdaptor
+  module Parsers
+    module ArrayParser
+      # Parse irregular endpoints that return an array of objects instead of the standard JSON response
+      def self.parse(response_data, collection_name)
+        raise InvalidResponseError, "collection name is not specified" unless collection_name
+
+        {
+          "count" => response_data.count,
+          "results" => response_data.map do |obj|
+            {
+              "key" => collection_name,
+              "id" => obj["id"].to_s
+            }
+          end,
+          collection_name => response_data.reduce({}) do |hash, obj|
+            hash[obj["id"].to_s] = obj
+            hash
+          end
+        }
+      end
+    end
+  end
+end

data/lib/brainstem_adaptor/response.rb

@@ -4,7 +4,7 @@ module BrainstemAdaptor
 
     # @param response_data [String, Hash]
     # @param specification [BrainstemAdaptor::Specification]
-    def initialize(response_data, specification = BrainstemAdaptor.default_specification)
+    def initialize(response_data, specification = BrainstemAdaptor.default_specification, **options)
       @specification = specification or raise ArgumentError, 'Specification is not set'
 
       case response_data
@@ -12,6 +12,8 @@ module BrainstemAdaptor
         @response_data = BrainstemAdaptor.parser.parse(response_data)
       when Hash
         @response_data = response_data
+      when Array
+        @response_data = BrainstemAdaptor::Parsers::ArrayParser.parse(response_data, options[:collection_name])
       else
         raise ArgumentError, "Expected String, got #{@response_data.class.name}"
       end

data/spec/lib/brainstem_adaptor/parsers/array_parser_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe BrainstemAdaptor::Parsers::ArrayParser do
+  describe ".parse" do
+    subject { described_class.parse(response_data, collection_name) }
+
+    let(:response_data) do
+      [
+        {
+          "id" => "1",
+          "title" => "An object"
+        },
+        {
+          "id" => "2",
+          "title" => "A newer object"
+        }
+      ]
+    end
+
+    let(:collection_name) { "workspaces" }
+
+    let(:formatted_response) do
+      {
+        "count" => response_data.count,
+        "results" => [
+          {
+            "key" => collection_name,
+            "id" => response_data[0]["id"]
+          },
+          {
+            "key" => collection_name,
+            "id" => response_data[1]["id"]
+          }
+        ],
+        collection_name => {
+          response_data[0]["id"] => response_data[0],
+          response_data[1]["id"] => response_data[1]
+        }
+      }
+    end
+
+    it "formats the response to match brainstem" do
+      expect(subject).to eq formatted_response
+    end
+
+    context "when collection name is not given" do
+      let(:collection_name) { nil }
+
+      it "raises an InvalidResponseError" do
+        expect { subject }.to raise_error(BrainstemAdaptor::InvalidResponseError)
+      end
+    end
+  end
+end

data/spec/lib/brainstem_adaptor/response_spec.rb

@@ -181,6 +181,17 @@ describe BrainstemAdaptor::Response do
     end
   end
 
+  context "when array input" do
+    subject { described_class.new(response_data, collection_name: collection_name) }
+    let(:response_data) { [{ "id" => "1" }] }
+    let(:collection_name) { "object" }
+
+    it "formats the response data using the array parser" do
+      expect(BrainstemAdaptor::Parsers::ArrayParser).to receive(:parse).with(response_data, collection_name).and_call_original
+      subject
+    end
+  end
+
   describe '#to_hash' do
     specify do
       expect(subject.to_hash).to eq(response_hash)

metadata

@@ -1,9 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: brainstem-adaptor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
+- Mavenlink
 - Sergei Zinin (einzige)
 autorequire: 
 bindir: bin
@@ -14,40 +15,42 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: Parses Brainstem responses, makes it convenient to organize access to
   your data.
-email: szinin@gmail.com
+email:
+- opensource@mavenlink.com
+- szinin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -55,17 +58,19 @@ files:
 - lib/brainstem-adaptor.rb
 - lib/brainstem_adaptor/association.rb
 - lib/brainstem_adaptor/invalid_response_error.rb
+- lib/brainstem_adaptor/parsers/array_parser.rb
 - lib/brainstem_adaptor/record.rb
 - lib/brainstem_adaptor/response.rb
 - lib/brainstem_adaptor/specification.rb
 - spec/lib/brainstem_adaptor/association_spec.rb
 - spec/lib/brainstem_adaptor/invalid_response_error_spec.rb
+- spec/lib/brainstem_adaptor/parsers/array_parser_spec.rb
 - spec/lib/brainstem_adaptor/record_spec.rb
 - spec/lib/brainstem_adaptor/response_spec.rb
 - spec/lib/brainstem_adaptor/specification_spec.rb
 - spec/lib/brainstem_adaptor_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/einzige/brainstem-adaptor
+homepage: https://github.com/mavenlink/brainstem-adaptor
 licenses:
 - MIT
 metadata: {}
@@ -75,17 +80,16 @@ 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: []
-rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Brainstem API Adaptor