backframe 0.0.49 → 1.0.0

data/spec/response/fields_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Backframe::Response::Fields do
+
+  it 'returns the default fields in the default order' do
+    actual = Backframe::Response::Fields.new(Backframe::Fixtures::Contact, nil)
+    expected = [
+      { label: "id", key: "id" },
+      { label: "first_name", key: "first_name" },
+      { label: "last_name", key: "last_name" },
+      { label: "email", key: "email" },
+      { label: "photo.id", key: "photo.id" },
+      { label: "photo.path", key: "photo.path" }
+    ]
+    expect(actual.any?).to eq(false)
+    expect(actual.array).to eq(expected)
+  end
+
+  it 'returns the fields with an alternate order' do
+    actual = Backframe::Response::Fields.new(Backframe::Fixtures::Contact, 'last_name,first_name')
+    expected = [
+      { label: "last_name", key: "last_name" },
+      { label: "first_name", key: "first_name" }
+    ]
+    expect(actual.array).to eq(expected)
+  end
+
+  it 'returns a field with an alias' do
+    actual = Backframe::Response::Fields.new(Backframe::Fixtures::Contact, 'First Name:first_name')
+    expected = [
+      { label: "First Name", key: "first_name" }
+    ]
+    expect(actual.array).to eq(expected)
+  end
+
+  it 'returns fields with mixed aliases' do
+    actual = Backframe::Response::Fields.new(Backframe::Fixtures::Contact, 'First Name:first_name,last_name')
+    expected = [
+      { label: "First Name", key: "first_name" },
+      { label: "last_name", key: "last_name" }
+    ]
+    expect(actual.array).to eq(expected)
+  end
+
+end

data/spec/response/record_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Backframe::Response::Record do
+
+  before(:all) do
+    @hash = { first_name: 'Greg', last_name: 'Kops', email: 'greg@thinktopography.com', photo: { id: 1, path: '/images/greg.jpg' } }
+  end
+
+  it 'casts a string path' do
+    actual = Backframe::Response::Record.cast_path('a')
+    expected = ['a']
+    expect(actual).to eq(expected)
+  end
+
+  it 'casts a nested string path' do
+    actual = Backframe::Response::Record.cast_path('a.b.c')
+    expected = ['a','b','c']
+    expect(actual).to eq(expected)
+  end
+
+  it 'casts a symbol path' do
+    actual = Backframe::Response::Record.cast_path(:a)
+    expected = ['a']
+    expect(actual).to eq(expected)
+  end
+
+  it 'casts an array path' do
+    actual = Backframe::Response::Record.cast_path(['a'])
+    expected = ['a']
+    expect(actual).to eq(expected)
+  end
+
+  it 'gets top level value' do
+    actual = Backframe::Response::Record.get_value(@hash, 'first_name')
+    expected = 'Greg'
+    expect(actual).to eq(expected)
+  end
+
+  it 'gets nested value' do
+    actual = Backframe::Response::Record.get_value(@hash, 'photo.id')
+    expected = 1
+    expect(actual).to eq(expected)
+  end
+
+end

data/spec/response_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+describe Backframe::Response do
+
+  before(:all) do
+    @records = [
+      { id: 1, first_name: 'Greg', last_name: 'Kops', email: 'greg@thinktopography.com', photo: { id: 1, path: '/images/greg.jpg' } },
+      { id: 2, first_name: 'Megan', last_name: 'Pugh', email: 'megan@thinktopography.com', photo: { id: 2, path: '/images/megan.jpg' } },
+      { id: 3, first_name: 'Kath', last_name: 'Tibbetts', email: 'kath@thinktopography.com', photo: { id: 3, path: '/images/kath.jpg' } },
+      { id: 4, first_name: 'Armand', last_name: 'Zerilli', email: 'armand@thinktopography.com', photo: { id: 4, path: '/images/armand.jpg' } }
+    ]
+  end
+
+  it 'handles success' do
+    actual = Backframe::Response.success({ text: 'test', content_type: 'text/plain' })
+    expected = { text: 'test', content_type: 'text/plain', status: 200 }
+    expect(actual).to eq(expected)
+  end
+
+  it 'handles failure' do
+    actual = Backframe::Response.failure('Application Error', 500)
+    expected = {
+      json: {
+        error: {
+          message: 'Application Error',
+          status: 500
+        }
+      },
+      content_type: 'application/json',
+      status: 500
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders error if no format provided' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'bat' })
+    expected = {
+      json: { error: { message: "Unknown Format", status: 404 } },
+      content_type: 'application/json',
+      status: 404
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders plain' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'json' })
+    expected = {
+      json: {
+        records: @records,
+        total_records: 4,
+        current_page: 1,
+        total_pages: 1
+      },
+      content_type: 'application/json',
+      status: 200
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders with pagination' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'json', page: 1,  per_page: 2 })
+    expected = {
+      json: {
+        records: @records[0, 2],
+        total_records: 4,
+        current_page: 1,
+        total_pages: 2
+      },
+      content_type: 'application/json',
+      status: 200
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders with fields' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'json', fields: 'First Name:first_name' })
+    expected = {
+      json: {
+        records: @records.map { |r| { first_name: r[:first_name]} },
+        total_records: 4,
+        current_page: 1,
+        total_pages: 1
+      },
+      content_type: 'application/json',
+      status: 200
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders default xml response' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'xml' })
+    expected = {
+      xml: [
+        '<?xml version="1.0"?><records>',
+        '<record><id>1</id><first_name>Greg</first_name><last_name>Kops</last_name><email>greg@thinktopography.com</email><photo.id>1</photo.id><photo.path>/images/greg.jpg</photo.path></record>',
+        '<record><id>2</id><first_name>Megan</first_name><last_name>Pugh</last_name><email>megan@thinktopography.com</email><photo.id>2</photo.id><photo.path>/images/megan.jpg</photo.path></record>',
+        '<record><id>3</id><first_name>Kath</first_name><last_name>Tibbetts</last_name><email>kath@thinktopography.com</email><photo.id>3</photo.id><photo.path>/images/kath.jpg</photo.path></record>',
+        '<record><id>4</id><first_name>Armand</first_name><last_name>Zerilli</last_name><email>armand@thinktopography.com</email><photo.id>4</photo.id><photo.path>/images/armand.jpg</photo.path></record>',
+        '</records>'
+      ].join,
+      content_type: "application/xhtml+xml",
+      status: 200
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders default csv response' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'csv' })
+    expected = {
+      text: [
+        'id,first_name,last_name,email,photo.id,photo.path',
+        '1,Greg,Kops,greg@thinktopography.com,1,/images/greg.jpg',
+        '2,Megan,Pugh,megan@thinktopography.com,2,/images/megan.jpg',
+        '3,Kath,Tibbetts,kath@thinktopography.com,3,/images/kath.jpg',
+        '4,Armand,Zerilli,armand@thinktopography.com,4,/images/armand.jpg'
+      ].join("\n"),
+      content_type: "text/plain",
+      status: 200
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders default tsv response' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'tsv' })
+    expected = {
+      text: [
+        "id\tfirst_name\tlast_name\temail\tphoto.id\tphoto.path",
+        "1\tGreg\tKops\tgreg@thinktopography.com\t1\t/images/greg.jpg",
+        "2\tMegan\tPugh\tmegan@thinktopography.com\t2\t/images/megan.jpg",
+        "3\tKath\tTibbetts\tkath@thinktopography.com\t3\t/images/kath.jpg",
+        "4\tArmand\tZerilli\tarmand@thinktopography.com\t4\t/images/armand.jpg"
+      ].join("\n"),
+      content_type: "text/plain",
+      status: 200
+    }
+    expect(actual).to eq(expected)
+  end
+
+  it 'renders default xlsx response' do
+    actual = Backframe::Response.render(Backframe::Fixtures::Contact, { format: 'xlsx' })
+    expect(actual[:content_type]).to eq('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+    expect(actual[:status]).to eq(200)
+    File.open('tmp.xlsx', 'w') { |file| file.write(actual[:text]) }
+    xlsx = Roo::Excelx.new('tmp.xlsx')
+    expect(xlsx.sheet(0).row(1)).to eq(["id", "first_name", "last_name", "email", "photo.id", "photo.path"])
+    expect(xlsx.sheet(0).row(2)).to eq(["1", "Greg", "Kops", "greg@thinktopography.com", "1", "/images/greg.jpg"])
+    expect(xlsx.sheet(0).row(3)).to eq(["2", "Megan", "Pugh", "megan@thinktopography.com", "2", "/images/megan.jpg"])
+    expect(xlsx.sheet(0).row(4)).to eq(["3", "Kath", "Tibbetts", "kath@thinktopography.com", "3", "/images/kath.jpg"])
+    expect(xlsx.sheet(0).row(5)).to eq(["4", "Armand", "Zerilli", "armand@thinktopography.com", "4", "/images/armand.jpg"])
+    File.unlink('tmp.xlsx')
+  end
+
+end

data/spec/service/result/failure_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Backframe::Service::Result::Failure do
+
+  it 'reports failure' do
+    records = Backframe::Service::Result::Failure.new({})
+    expect(records.success?).to be false
+  end
+
+  it 'provides access to value object' do
+    records = Backframe::Service::Result::Failure.new(message: 'There was a problem', errors: {})
+    expect(records.message).to eq('There was a problem')
+    expect(records.errors).to eq({})
+  end
+
+end

data/spec/service/result/sucess_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Backframe::Service::Result::Success do
+
+  it 'reports success' do
+    records = Backframe::Service::Result::Success.new({})
+    expect(records.success?).to be true
+  end
+
+  it 'provides access to value object' do
+    records = Backframe::Service::Result::Success.new({ one: 1, two: 2, three: 3 })
+    expect(records.one).to eq(1)
+    expect(records.two).to eq(2)
+    expect(records.three).to eq(3)
+  end
+
+end

data/spec/service_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Backframe::Service do
+
+  it 'succeeds' do
+    result = Backframe::Fixtures::CreateContactService.perform({ first_name: 'Joe', last_name: 'Doe', email: 'john.doe@gmail.com' })
+    expect(result.success?).to be(true)
+    expect(result.contact.first_name).to eq('Joe')
+  end
+
+  it 'fails' do
+    result = Backframe::Fixtures::CreateContactService.perform({})
+    expect(result.success?).to be(false)
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,61 +1,24 @@
-ENV['RAILS_ENV'] = 'test'
+require "codeclimate-test-reporter"
 
-require 'backframe'
-
-require 'rails'
-require 'action_controller/railtie'
-require 'active_model_serializers'
-require 'active_model_serializers/railtie'
-require 'active_record'
-require 'factory_girl'
-require 'kaminari'
-require 'rspec/rails'
-
-LOGGER = Logger.new('/dev/null')
-
-Rails.logger = LOGGER
-ActiveModelSerializers.logger = LOGGER
-ActiveRecord::Base.logger = LOGGER
+CodeClimate::TestReporter.start
 
-DATABASE = {
-  adapter: 'sqlite3',
-  database: ':memory:'
-}
-
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Base.establish_connection(DATABASE)
-
-module Backframe
-  class Application < ::Rails::Application
-    def self.find_root(from)
-      Dir.pwd
-    end
-
-    config.eager_load = false
-    config.secret_key_base = 'secret'
-  end
-end
+require 'fixtures/active_record'
+require 'fixtures/models'
+require 'fixtures/serializers'
+require 'fixtures/queries'
+require 'fixtures/services'
+require 'fixtures/seeds'
+require 'backframe'
+require 'roo'
 
-Backframe::Application.initialize!
-Backframe::Mime.register_types
+RSpec.configure do |config|
 
-module Helpers
-  def json_response
-    @json_response ||= JSON.parse(response.body).with_indifferent_access
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  def serialize(value, opts = {})
-    opts[:adapter] ||= Backframe::ActsAsAPI::Adapter
-    ActiveModel::SerializableResource.new(value, opts).as_json
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
   end
-end
 
-RSpec.configure do |config|
-  config.include Helpers
-  config.include Rails.application.routes.url_helpers
-  config.include FactoryGirl::Syntax::Methods
-
-  config.use_transactional_fixtures = true
 end
-
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,46 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: backframe
 version: !ruby/object:Gem::Version
-  version: 0.0.49
+  version: 1.0.0
 platform: ruby
 authors:
 - Greg Kops
-- Scott Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: write_xlsx
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.83.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.83.0
-- !ruby/object:Gem::Dependency
-  name: phony
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.15.21
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.15.21
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -54,102 +39,102 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0.rc4
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0.rc4
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: write_xlsx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.83.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
-description: Rails bindings for Reframe
-email: hello@thinktopography.com
+        version: 0.83.0
+description: A collection of core objects for writing testable APIs
+email: greg@thinktopography.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
-- ".idea/vcs.xml"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile
 - backframe.gemspec
 - circle.yml
 - lib/backframe.rb
-- lib/backframe/actioncontroller/acts_as_activation.rb
-- lib/backframe/actioncontroller/acts_as_api.rb
-- lib/backframe/actioncontroller/acts_as_api/adapter.rb
-- lib/backframe/actioncontroller/acts_as_api/errors.rb
-- lib/backframe/actioncontroller/acts_as_api/headers.rb
-- lib/backframe/actioncontroller/acts_as_api/page.rb
-- lib/backframe/actioncontroller/acts_as_reset.rb
-- lib/backframe/actioncontroller/acts_as_resource.rb
-- lib/backframe/actioncontroller/acts_as_resource/actions.rb
-- lib/backframe/actioncontroller/acts_as_session.rb
-- lib/backframe/activerecord/acts_as_activable.rb
-- lib/backframe/activerecord/acts_as_distinct.rb
-- lib/backframe/activerecord/acts_as_enum.rb
-- lib/backframe/activerecord/acts_as_orderable.rb
-- lib/backframe/activerecord/acts_as_percent.rb
-- lib/backframe/activerecord/acts_as_phone.rb
-- lib/backframe/activerecord/acts_as_user.rb
-- lib/backframe/activerecord/default_values.rb
-- lib/backframe/activerecord/filter_sort.rb
-- lib/backframe/activerecord/migration.rb
-- lib/backframe/image_cache/image_cache.rb
-- lib/backframe/image_cache/lib/asset.rb
-- lib/backframe/image_cache/lib/cache.rb
-- lib/backframe/image_cache/lib/conversions.rb
 - lib/backframe/mime.rb
-- lib/backframe/models/activation.rb
-- lib/backframe/models/activity.rb
-- lib/backframe/models/reset.rb
-- lib/backframe/models/story.rb
+- lib/backframe/query.rb
+- lib/backframe/query/sort.rb
 - lib/backframe/railtie.rb
-- lib/backframe/serializers/activity_serializer.rb
+- lib/backframe/response.rb
+- lib/backframe/response/adapter/csv.rb
+- lib/backframe/response/adapter/json.rb
+- lib/backframe/response/adapter/xlsx.rb
+- lib/backframe/response/adapter/xml.rb
+- lib/backframe/response/collection.rb
+- lib/backframe/response/fields.rb
+- lib/backframe/response/record.rb
+- lib/backframe/service.rb
+- lib/backframe/service/result/base.rb
+- lib/backframe/service/result/failure.rb
+- lib/backframe/service/result/success.rb
 - lib/backframe/version.rb
-- spec/backframe/acts_as_api_spec.rb
-- spec/backframe/acts_as_resource_spec.rb
+- spec/fixtures/active_record.rb
+- spec/fixtures/models.rb
+- spec/fixtures/queries.rb
+- spec/fixtures/seeds.rb
+- spec/fixtures/serializers.rb
+- spec/fixtures/services.rb
+- spec/query/sort_spec.rb
+- spec/query_spec.rb
+- spec/response/adapter/csv_spec.rb
+- spec/response/adapter/json_spec.rb
+- spec/response/adapter/xlsx_spec.rb
+- spec/response/adapter/xml_spec.rb
+- spec/response/fields_spec.rb
+- spec/response/record_spec.rb
+- spec/response_spec.rb
+- spec/service/result/failure_spec.rb
+- spec/service/result/sucess_spec.rb
+- spec/service_spec.rb
 - spec/spec_helper.rb
-- spec/support/example.rb
-- spec/support/example_factory.rb
-- spec/support/example_serializer.rb
-- spec/support/schema.rb
-homepage: 
-licenses: []
+homepage: https://github.com/thinktopography/backframe
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -170,12 +155,24 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Backframe
+summary: backframe
 test_files:
-- spec/backframe/acts_as_api_spec.rb
-- spec/backframe/acts_as_resource_spec.rb
+- spec/fixtures/active_record.rb
+- spec/fixtures/models.rb
+- spec/fixtures/queries.rb
+- spec/fixtures/seeds.rb
+- spec/fixtures/serializers.rb
+- spec/fixtures/services.rb
+- spec/query/sort_spec.rb
+- spec/query_spec.rb
+- spec/response/adapter/csv_spec.rb
+- spec/response/adapter/json_spec.rb
+- spec/response/adapter/xlsx_spec.rb
+- spec/response/adapter/xml_spec.rb
+- spec/response/fields_spec.rb
+- spec/response/record_spec.rb
+- spec/response_spec.rb
+- spec/service/result/failure_spec.rb
+- spec/service/result/sucess_spec.rb
+- spec/service_spec.rb
 - spec/spec_helper.rb
-- spec/support/example.rb
-- spec/support/example_factory.rb
-- spec/support/example_serializer.rb
-- spec/support/schema.rb