atum 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7c37a12fcdbcf41017d8e62a6c75f8669bdeaf3
+  data.tar.gz: 5434d95df87ef0963ff3515a6e69b75e4104fa5b
+SHA512:
+  metadata.gz: aa8d0da68c90f34cfb93cf9b7dcf3782186584e2e523f3695e8f4e2356d94bfaf6c1c353d26b0de0decf08c02abe748918fc33e27157c9aaf73783f0a6087aad
+  data.tar.gz: 6e2576f7ff46687e1208fae1ee4eee882d08fc52f34ecb55af8b57113eb18eac977db6bcd9580aa3076f4aab27429b15354dfe0dfe065bb3cac3d29704eb041b

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - Guardfile
+    - atum.gemspec
+    - vendor/**/*
+    - spec/fixtures/fruity_client/**/*
+    - tmp/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,25 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-09-29 16:05:25 +0100 using RuboCop version 0.26.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 90
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 16
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+script: rubocop && rspec spec
+rvm:
+  - 2.0.0
+  - 2.0.0-p353
+  - 2.1
+gemfile:
+  - gemfiles/faraday_0.9.gemfile
+  - gemfiles/faraday_0.8.9.gemfile

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "faraday-0.8.9" do
+  gem "faraday", "~> 0.8.9"
+  gem "atum", :path => "../"
+end
+
+appraise "faraday-0.9" do
+  gem "faraday", "~> 0.9"
+  gem "paperclip", :path => "../"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.2
+
+- Actions which don't require a body can now be passed optional parameters

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+## Contributing
+
+Atum is a fork of [Heroics](https://github.com/interagent/heroics). It is
+adapted to consume [JSON API](http://jsonapi.org)-compliant APIs, and output
+generated clients into a folder rather than a single file.
+
+We welcome contributions to Atum and discussion about its design and
+functionality.  Please open an issue or pull request on this repository to
+propose a change.

data/CONTRIBUTORS.md

@@ -0,0 +1,15 @@
+# Contributors
+## Original [Heroics](https://github.com/interagent/heroics) contributors:
+
+Andrea Salicetti <andrea.salicetti@gmail.com>
+Jamu Kakar <jkakar@kakar.ca>
+Jonathan Roes <jroes@jroes.net>
+Mark Fine <mark.fine@gmail.com>
+Mark McGranaghan <mmcgrana@gmail.com>
+Neil Middleton <neil@heroku.com>
+Wesley Beary <geemus+github@gmail.com>
+
+## Atum contributors
+
+Pete Hamilton <peterejhamilton@gmail.com>
+Isaac Seymour <i.seymour@oxon.org>

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in atum.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/.+\.(rb|erb)$})       { 'spec/integration' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  watch(%r{(?:.+/)?\.rubocop\_todo\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 geemus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Atum
+
+Ruby HTTP client generator for JSON APIs represented with JSON schema, forked
+from [Heroics](https://github.com/interagent/heroics).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atum'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install atum
+
+## Usage
+
+### Generating a client
+
+Atum generates an HTTP client from a JSON schema that describes your JSON
+API. Look at [prmd](https://github.com/interagent/prmd) for tooling to help
+write a JSON schema.  When you have a JSON schema prepared you can generate a
+client for your API:
+
+```
+$ atum MyApp schema.json https://api.myapp.com
+```
+
+This will output a client into a new `my_app` folder, in the current directory,
+unless that folder exists.
+
+### Passing custom headers
+
+If your client needs to pass custom headers with each request these can be
+specified using `-H`:
+
+```
+atum -H "Accept: application/vnd.myapp+json; version=3" MyApp schema.json https://api.myapp.com
+```
+
+Pass multiple `-H` options if you need more than one custom header.
+
+### Generating API documentation
+
+The generated client has [Yard](http://yardoc.org/)-compatible docstrings.
+You can generate documentation using `yard`:
+
+__not convinced this is actually correct now it's a directory?__
+```
+yard doc -m markdown my_app
+```
+
+This will generate HTML in the `docs` directory.  Note that Yard creates an
+`_index.html` page won't be served by Jekyll on GitHub Pages.  Add a
+`.nojekyll` file to your project to prevent GitHub from passing the content
+through Jekyll.
+
+### Handling failures
+
+The client uses [Faraday](https://github.com/lostisland/faraday) for doing the
+HTTP requests, which chooses the most appropriate library for the runtime and
+other cool things. As such, you may encounter Faraday errors, which are mostly
+subclasses of `Faraday::ClientError`.
+
+```ruby
+begin
+  client.app.create('name' => 'example')
+rescue Faraday::ClientError => error
+  puts error
+end
+```
+
+## Supporting Ruby < 2.0.0
+This gem only directly supports Ruby >= 2.0.0 out of the box due to our use of
+Enumerable::Lazy for lazy loading of paginated API resources.
+
+However, support for previous ruby versions can be added using a gem such as
+[backports](https://github.com/marcandre/backports).
+
+1. Add backports to your Gemfile
+   ```gem 'backports'```
+2. Require lazy enumerables
+   ```require 'backports/2.0.0/enumerable/lazy.rb'```
+
+## Contributing
+
+1. [Fork the repository](https://github.com/isaacseymour/atum/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new pull request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.verbose = true
+  task.ruby_opts << '-r turn/autorun'
+  task.ruby_opts << '-I test'
+  task.test_files = FileList['test/**/*_test.rb', 'test/**/*_spec.rb']
+end
+
+task default: :test

data/TODO

@@ -0,0 +1,3 @@
+how to handle ranges (note that this probably implies more complex cache behavior also)
+
+how to recognize/handle singular resources (ie account and config-vars)

data/atum.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'atum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'atum'
+  spec.version       = Atum::VERSION
+  spec.authors       = %w(isaacseymour petehamilton)
+  spec.email         = ['i.seymour@oxon.org', 'peterejhamilton@gmail.com']
+  spec.description   = 'A Ruby client generator for JSON APIs described with a JSON schema'
+  spec.summary       = 'A Ruby client generator for JSON APIs described with a JSON schema'
+  spec.homepage      = 'https://github.com/gocardless/atum'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep('^(test|spec|features)/')
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rubocop', '~> 0.26'
+  spec.add_development_dependency 'guard', '~> 2.6'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.1'
+  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'appraisal', '~> 1.0.2'
+
+  spec.add_dependency 'erubis', '~> 2.7'
+  spec.add_dependency 'faraday', '>= 0.8.9'
+  spec.add_dependency 'activesupport', '~> 4.1'
+end

data/bin/atum

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'atum'
+
+options = { headers: {} }
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: atum module_name schema_filename url'
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+
+  opts.on('-v', '--version', 'Display the version atum is running at') do
+    puts Atum::VERSION
+    exit
+  end
+
+  opts.on('-H', '--header [HEADER]',
+          'Include header with all requests') do |header|
+    header_key, header_value, _ = header.split(':', 0)
+    options[:headers][header_key] = header_value.strip
+  end
+end
+
+option_parser.parse!
+
+if ARGV.length != 3
+  puts option_parser
+  exit
+end
+
+options = { default_headers: options[:headers] }
+
+module_name, schema_filename, url = ARGV
+
+generator = Atum::Generation::GeneratorService.new(module_name, schema_filename,
+                                                   url, options)
+generator.generate_files

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.0.0-p353
+
+test:
+  pre:
+    - bundle exec rubocop

data/gemfiles/faraday_0.8.9.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.8.9"
+gem "atum", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/faraday_0.9.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.9"
+gem "atum", :path => "../"
+
+gemspec :path => "../"

data/lib/atum.rb

@@ -0,0 +1,15 @@
+require 'base64'
+require 'erubis'
+require 'faraday'
+require 'json'
+require 'uri'
+require 'zlib'
+require 'active_support/inflector'
+
+# Atum is an HTTP client for an API described by a JSON schema.
+module Atum
+end
+
+require 'atum/version'
+require 'atum/core'
+require 'atum/generation'

data/lib/atum/core.rb

@@ -0,0 +1,13 @@
+module Atum
+  module Core
+  end
+end
+
+require 'atum/core/errors'
+require 'atum/core/client'
+require 'atum/core/resource'
+require 'atum/core/link'
+require 'atum/core/request'
+require 'atum/core/response'
+require 'atum/core/paginator'
+require 'atum/core/schema'

data/lib/atum/core/client.rb

@@ -0,0 +1,45 @@
+module Atum
+  module Core
+    class Client
+      class << self
+        # Create an HTTP client from a schema.
+        #
+        # @param schema [ApiSchema] The schema to build an HTTP client for.
+        # @param url [String] The URL the generated client should use
+        # @param options [Hash] Configuration for links. Possible keys include:
+        #   - default_headers: Optionally, a set of headers to include in every
+        #     request made by the client.  Default is no custom headers.
+        # @return [Client] A client with resources and links from the schema
+        def client_from_schema(api_schema, url, options = {})
+          resources = {}
+          api_schema.resource_schemas.each do |resource_schema|
+            links_hash = {}
+            resource_schema.link_schemas.each do |link_schema|
+              links_hash[link_schema.name] = Link.new(url, link_schema, options)
+            end
+            resources[resource_schema.name] = Resource.new(links_hash)
+          end
+
+          new(resources, url)
+        end
+      end
+
+      # @param resources [Hash<String,Resource>] Methods names -> Resources
+      # @param url [String] The URL used by this client.
+      def initialize(resources, url)
+        @url = url
+        resources.each do |name, resource|
+          define_singleton_method(name) { resource }
+        end
+      end
+
+      def inspect
+        url = URI.parse(@url)
+        url.password = 'REDACTED' unless url.password.nil?
+        "#<Atum::Client url=\"#{url}\">"
+      end
+
+      alias_method :to_s, :inspect
+    end
+  end
+end