atum 0.5.0

data/spec/fixtures/sample_schema.json

@@ -0,0 +1,139 @@
+{
+  "description": "Sample schema for use in tests.",
+  "definitions": {
+    "resource": {
+      "description": "A sample resource to use in tests.",
+      "id": "schema/resource",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "title": "Sample resource title",
+      "type": ["object"],
+      "definitions": {
+        "date_field": {
+          "description": "A sample date field",
+          "example": "2013-10-19 22:10:29Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": ["string"]
+        },
+        "string_field": {
+          "description": "A sample string field",
+          "example": "Sample text.",
+          "readOnly": true,
+          "type": ["string"]
+        },
+        "boolean_field": { "description": "A sample boolean field", "example": true, "type": ["boolean"] },
+        "uuid_field": {
+          "description": "A sample UUID field",
+          "example": "44724831-bf66-4bc2-865f-e2c4c2b14c78",
+          "format": "uuid",
+          "readOnly": true,
+          "type": ["string"]
+        },
+        "email_field": {
+          "description": "A sample email address field",
+          "example": "username@example.com",
+          "format": "email",
+          "readOnly": true,
+          "type": ["string"]
+        },
+        "identity": {
+          "oneOf": [
+            { "$ref": "#/definitions/resource/definitions/uuid_field" },
+            { "$ref": "#/definitions/resource/definitions/email_field" }
+          ]
+        }
+      },
+      "properties": {
+        "date_field": { "$ref": "#/definitions/resource/definitions/date_field" },
+        "string_field": { "$ref": "#/definitions/resource/definitions/string_field" },
+        "boolean_field": { "$ref": "#/definitions/resource/definitions/boolean_field" },
+        "uuid_field": { "$ref": "#/definitions/resource/definitions/uuid_field" },
+        "email_field": { "$ref": "#/definitions/resource/definitions/email_field" }
+      },
+      "links": [
+        {
+          "description": "Show all sample resources",
+          "href": "/resource",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        },
+        {
+          "description": "Show a sample resource",
+          "href": "/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fuuid_field)}",
+          "method": "GET",
+          "rel": "self",
+          "title": "Info"
+        },
+        {
+          "description": "Show a sample resource",
+          "href": "/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fidentity)}",
+          "method": "GET",
+          "rel": "self",
+          "title": "Identify resource"
+        },
+        {
+          "description": "Create a sample resource",
+          "href": "/resource",
+          "method": "POST",
+          "rel": "create",
+          "title": "Create",
+          "schema": {
+            "properties": {
+              "date_field": { "$ref": "#/definitions/resource/definitions/date_field" },
+              "string_field": { "$ref": "#/definitions/resource/definitions/string_field" },
+              "boolean_field": { "$ref": "#/definitions/resource/definitions/boolean_field" },
+              "uuid_field": { "$ref": "#/definitions/resource/definitions/uuid_field" },
+              "email_field": { "$ref": "#/definitions/resource/definitions/email_field" }
+            }
+          }
+        },
+        {
+          "description": "Update a sample resource",
+          "href": "/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fuuid_field)}",
+          "method": "PATCH",
+          "rel": "update",
+          "title": "Update",
+          "schema": {
+            "properties": {
+              "date_field": { "$ref": "#/definitions/resource/definitions/date_field" },
+              "string_field": { "$ref": "#/definitions/resource/definitions/string_field" },
+              "boolean_field": { "$ref": "#/definitions/resource/definitions/boolean_field" },
+              "uuid_field": { "$ref": "#/definitions/resource/definitions/uuid_field" },
+              "email_field": { "$ref": "#/definitions/resource/definitions/email_field" }
+            }
+          }
+        },
+        {
+          "description": "Delete an existing sample resource at specific time",
+          "href": "/resource/{(%23%2Fdefinitions%2Fresource%2Fdefinitions%2Fdate_field)}",
+          "method": "DELETE",
+          "rel": "destroy",
+          "title": "Delete"
+        }
+      ]
+    },
+    "another-resource": {
+      "description": "Another sample resource to use in tests.",
+      "id": "schema/another-resource",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "title": "Another sample resource title",
+      "type": ["object"],
+      "definitions": { },
+      "properties": { },
+      "links": [
+        {
+          "description": "Show all sample resources",
+          "href": "/another-resource",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        }
+      ]
+    }
+  },
+  "properties": {
+    "resource": { "$ref": "#/definitions/resource" },
+    "another-resource": { "$ref": "#/definitions/another-resource" }
+  }
+}

data/spec/integration/client_integration_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe 'The Generated Client' do
+  let(:name) { 'Fruity' }
+  let(:schema_file) do
+    File.expand_path('../fixtures/fruity_schema.json', File.dirname(__FILE__))
+  end
+  let(:url) { 'http://USER:PASSWORD@api.fruity.com/fruits' }
+  let(:tmp_folder) do
+    File.expand_path(File.join('..', '..', '..', 'tmp'), File.dirname(__FILE__))
+  end
+  let(:options) { { path: File.join(tmp_folder, 'client') } }
+  let(:generator_service) do
+    Atum::Generation::GeneratorService.new(name, schema_file, url, options)
+  end
+
+  before do
+    generator_service.generate_files
+    require File.join(options[:path], 'fruity')
+    Fruity.connect('PASSWORD', user: 'USER', url: url)
+  end
+  after { FileUtils.rm_rf(tmp_folder) }
+
+  it 'can make get requests' do
+    stub = WebMock.stub_request(:get, "#{url}/lemon")
+    Fruity.lemon.list
+    expect(stub).to have_been_requested
+  end
+
+  it 'can make get requests with url params' do
+    lemon_id = 'MYLEMONID'
+    stub = WebMock.stub_request(:get, "#{url}/lemon/#{lemon_id}")
+    Fruity.lemon.info(lemon_id)
+    expect(stub).to have_been_requested
+  end
+
+  it 'can make requests with custom headers' do
+    headers = { 'Accept' => 'application/json', 'Api-Version' => '2014-09-01',
+                'Content-Type' => 'application/json' }
+    stub = WebMock.stub_request(:get, "#{url}/lemon").with do |request|
+      expect(request.headers).to include(headers)
+    end
+    Fruity.lemon.list(headers: headers)
+    expect(stub).to have_been_requested
+  end
+
+  it 'passes through query params' do
+    query = { 'size' => 'large' }
+    stub = WebMock.stub_request(:get, "#{url}/lemon?size=large")
+    Fruity.lemon.list(query: query)
+    expect(stub).to have_been_requested
+  end
+
+  it 'can use href params and pass query params' do
+    lemon_id = 'MYLEMONID'
+    query = { 'size' => 'large' }
+    stub = WebMock.stub_request(:get, "#{url}/lemon/#{lemon_id}?size=large")
+    Fruity.lemon.info(lemon_id, query: query)
+    expect(stub).to have_been_requested
+  end
+
+  it 'just returns non-json responses' do
+    body = 'MYBODY'
+    WebMock.stub_request(:get, "#{url}/lemon")
+      .to_return(body: body, headers: { 'Content-Type' => 'application/text' })
+    expect(Fruity.lemon.list).to eq(body)
+  end
+
+  it 'unenvelopes json api responses' do
+    lemon_body = { 'lemon_uuid' => 'MYLEMONID' }
+    lemon_id = 'MYLEMONID'
+    WebMock.stub_request(:get, "#{url}/lemon/#{lemon_id}")
+      .to_return(body: { 'lemons' => lemon_body }.to_json,
+                 headers: { 'Content-Type' => 'application/json' })
+    expect(Fruity.lemon.info(lemon_id)).to eq(lemon_body)
+  end
+
+  it 'can send raw POST bodies' do
+    body = 'MYBODY'
+    WebMock.stub_request(:post, "#{url}/lemon")
+      .with(body: body)
+    expect(Fruity.lemon.create(body: body))
+  end
+
+  it 'sends JSON when POST-ing a hash' do
+    body = { size: 'large', is_ripe: true, date_picked: Time.now }
+    WebMock.stub_request(:post, "#{url}/lemon")
+      .with(body: body.to_json)
+    expect(Fruity.lemon.create(body: body))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'stringio'
+require 'webmock'
+require 'webmock/rspec'
+require 'pry'
+require_relative '../lib/atum'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# A simple JSON schema for testing purposes.
+schema_file = File.expand_path('./fixtures/sample_schema.json',
+                               File.dirname(__FILE__))
+SAMPLE_SCHEMA = JSON.load(File.open(schema_file))

metadata

@@ -0,0 +1,303 @@
+--- !ruby/object:Gem::Specification
+name: atum
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- isaacseymour
+- petehamilton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: A Ruby client generator for JSON APIs described with a JSON schema
+email:
+- i.seymour@oxon.org
+- peterejhamilton@gmail.com
+executables:
+- atum
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
+- CONTRIBUTING.md
+- CONTRIBUTORS.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- atum.gemspec
+- bin/atum
+- circle.yml
+- gemfiles/faraday_0.8.9.gemfile
+- gemfiles/faraday_0.9.gemfile
+- lib/atum.rb
+- lib/atum/core.rb
+- lib/atum/core/client.rb
+- lib/atum/core/errors.rb
+- lib/atum/core/link.rb
+- lib/atum/core/paginator.rb
+- lib/atum/core/request.rb
+- lib/atum/core/resource.rb
+- lib/atum/core/response.rb
+- lib/atum/core/schema.rb
+- lib/atum/core/schema/api_schema.rb
+- lib/atum/core/schema/link_schema.rb
+- lib/atum/core/schema/parameter.rb
+- lib/atum/core/schema/parameter_choice.rb
+- lib/atum/core/schema/resource_schema.rb
+- lib/atum/generation.rb
+- lib/atum/generation/erb_context.rb
+- lib/atum/generation/errors.rb
+- lib/atum/generation/generator_link.rb
+- lib/atum/generation/generator_resource.rb
+- lib/atum/generation/generator_service.rb
+- lib/atum/generation/generators/base_generator.rb
+- lib/atum/generation/generators/client_generator.rb
+- lib/atum/generation/generators/module_generator.rb
+- lib/atum/generation/generators/resource_generator.rb
+- lib/atum/generation/generators/views/client.erb
+- lib/atum/generation/generators/views/module.erb
+- lib/atum/generation/generators/views/resource.erb
+- lib/atum/generation/options_parameter.rb
+- lib/atum/version.rb
+- spec/atum/core/client_spec.rb
+- spec/atum/core/errors_spec.rb
+- spec/atum/core/link_spec.rb
+- spec/atum/core/paginator_spec.rb
+- spec/atum/core/request_spec.rb
+- spec/atum/core/resource_spec.rb
+- spec/atum/core/response_spec.rb
+- spec/atum/core/schema/api_schema_spec.rb
+- spec/atum/core/schema/link_schema_spec.rb
+- spec/atum/core/schema/parameter_choice_spec.rb
+- spec/atum/core/schema/parameter_spec.rb
+- spec/atum/core/schema/resource_schema_spec.rb
+- spec/atum/generation/generator_link_spec.rb
+- spec/atum/generation/generator_resource_spec.rb
+- spec/atum/generation/generator_service_spec.rb
+- spec/atum/generation/generators/base_generator_spec.rb
+- spec/atum/generation/generators/client_generator_spec.rb
+- spec/atum/generation/generators/module_generator_spec.rb
+- spec/atum/generation/generators/resource_generator_spec.rb
+- spec/atum/generation/options_parameter_spec.rb
+- spec/fixtures/fruity_schema.json
+- spec/fixtures/sample_schema.json
+- spec/integration/client_integration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/atum
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A Ruby client generator for JSON APIs described with a JSON schema
+test_files: []