wordsmith-ruby-sdk 1.0.2

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Change Log
+All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased](https://github.com/automatedinsightsinc/wordsmith-ruby-sdk/compare/v1.0.1...HEAD)
+
+## [1.0.2](https://github.com/AutomatedInsightsInc/wordsmith-ruby-sdk/tree/v1.0.1) - 2016-04-27
+##### Added
+- Codeclimate test coverage reporter with dotenv for codeclimate token.
+- Required ruby version in gemspec.
+
+##### Changed
+- Gem version number bumped (missed bump in 1.0.0 release)
+
+## 1.0.0 - 2015-03-30
+
+##### Added
+- Enabled test converage for generating output since encoding has been fixed on the api.
+- A place to put a test token in `test/test_helper.rb`, should be Robert's token to match actual projects to test against.
+
+##### Changed
+- Updated configuration default url to https://api.automatedinsights.com/v1
+- Updated project generate output url to match routes in v1 api.
+
+## 0.0.2 - 2015-02-02
+
+##### Added
+- Test coverage using minitest.
+- Lots of README updates.
+- CHANGELOG file.
+
+##### Removed
+- Rails dependencies.
+- Configuration through yaml file.
+
+##### Changed
+- Configuration through conventional configuration methods.
+
+## 0.0.1 - 2015-01-21
+- Prototype requiring railties.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016, Automated Insights, Inc. All rights reserved.
+
+You are hereby granted a non-exclusive, worldwide, royalty-free license to
+use, copy, modify, and distribute this software in source code or binary
+form for use in connection with the web services and APIs provided by
+Automated Insights and its Wordsmith platform.
+
+As with any software that integrates with the Wordsmith platform, your use
+of this software is subject to the Wordsmith Terms of Service
+[https://automatedinsights.com/terms-of-use/]. This copyright 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,47 @@
+[![Code Climate](https://codeclimate.com/repos/5720c4b8e7b46b37e1002bfe/badges/3c997ae42848b5faf8ad/gpa.svg)](https://codeclimate.com/repos/5720c4b8e7b46b37e1002bfe/feed)
+[![Test Coverage](https://codeclimate.com/repos/5720c4b8e7b46b37e1002bfe/badges/3c997ae42848b5faf8ad/coverage.svg)](https://codeclimate.com/repos/5720c4b8e7b46b37e1002bfe/coverage)
+[![Issue Count](https://codeclimate.com/repos/5720c4b8e7b46b37e1002bfe/badges/3c997ae42848b5faf8ad/issue_count.svg)](https://codeclimate.com/repos/5720c4b8e7b46b37e1002bfe/feed)
+
+# Wordsmith SDK for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wordsmith-ruby-sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Configuration
+Configure in initializer or as desired
+
+```ruby
+#config/initializers/wordsmith.rb
+Wordsmith.configure do |config|
+  config.token = MY_API_TOKEN
+  config.url = 'https://api.automatedinsights.com/v1' #optional, this is the default value
+end
+```
+  
+## Usage
+```ruby
+projects = Wordsmith::Project.all                 #an array of projects your token can access
+project = Wordsmith::Project.find('project-slug') #fetch a project by slug
+
+project.schema     #the data schema for the project
+project.templates  #a collection of templates for this project
+
+template = project.templates.find('template-slug')           #fetch a template by slug
+template.generate({a_data_point: 1, another_one: 'Tuesday'}) #generate content
+ > {content: 'Your content is here!'}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/automatedinsightsinc/wordsmith-ruby-sdk.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+#  t.options = '--verbose'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wordsmith/sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wordsmith-ruby-sdk.rb

@@ -0,0 +1,6 @@
+require 'wordsmith/version'
+require 'wordsmith/project'
+require 'wordsmith/template'
+require 'wordsmith/template_collection'
+require 'wordsmith/configuration'
+require 'wordsmith/client'

data/lib/wordsmith/client.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'json'
+require 'hashie'
+
+module Wordsmith
+  class Client
+
+    def get(uri)
+      response = connection.get uri
+      parse_response response
+    end
+
+    def post(uri, data)
+      response = connection.post uri, {data: data}.to_json
+      parse_response response
+    end
+
+    private
+
+    def connection
+      return @_connection if connection_valid?
+      @_connection = Faraday.new(url: Wordsmith.configuration.url, headers: {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{Wordsmith.configuration.token}",
+        'User-Agent' => Wordsmith.configuration.user_agent
+      })
+    end
+
+    def connection_valid?
+      return false unless @_connection
+      url = @_connection.url_prefix.to_s
+      authorization = @_connection.headers['Authorization']
+
+      url == Wordsmith.configuration.url &&
+        authorization == "Bearer #{Wordsmith.configuration.token}"
+    end
+
+    def parse_response(response)
+      body = JSON.parse(response.body)
+      Hashie.symbolize_keys! body
+      case response.status
+      when 200, 201
+        return body[:data]
+      when 400
+        fail %Q(Bad Request: "#{body[:error]}")
+      when 401
+        fail 'API authorization error'
+      else
+        fail 'API error'
+      end
+    end
+  end
+
+  module_function
+
+  def client
+    @_client ||= Client.new
+  end
+end

data/lib/wordsmith/configuration.rb

@@ -0,0 +1,26 @@
+module Wordsmith
+  class Configuration
+    attr_accessor :token, :url, :user_agent
+    DEFAULT_URL = 'https://api.automatedinsights.com/v1'
+    DEFAULT_USER_AGENT = "RubySDK/#{Wordsmith::VERSION}"
+
+    def initialize
+      @url = DEFAULT_URL
+      @user_agent = DEFAULT_USER_AGENT
+    end
+  end
+
+  module_function
+
+  def configuration
+    @_configuration ||= Configuration.new
+  end
+
+  def configure
+    yield configuration
+  end
+
+  def reset
+    @_configuration = Configuration.new
+  end
+end

data/lib/wordsmith/project.rb

@@ -0,0 +1,31 @@
+class Wordsmith::Project
+  attr_reader :name, :slug, :templates
+
+  def self.all
+    projects_attributes = Wordsmith.client.get 'projects'
+    projects_attributes.map {|p| new(**p)}
+  end
+
+  def self.find(slug)
+    project = all.find { |p| p.slug == slug }
+    project or fail %Q(Project not found with slug: "#{slug}")
+  end
+
+  def schema
+    @_schema ||=
+      begin
+        body = Wordsmith.client.get "projects/#{slug}"
+        body[:schema]
+      end
+  end
+
+  private
+
+  def initialize(name: nil, slug: nil, templates: nil)
+    raise "Missing required kword arguments" unless [name, slug, templates].all?
+    @name = name
+    @slug = slug
+    @templates = Wordsmith::TemplateCollection.new(
+      templates.map {|t| Wordsmith::Template.new project: self, **t})
+  end
+end

data/lib/wordsmith/template.rb

@@ -0,0 +1,14 @@
+class Wordsmith::Template
+  attr_reader :name, :slug, :project
+
+  def initialize(name: nil, slug: nil, project: nil)
+    raise "Missing required kword arguments" unless [name, slug, project].all?
+    @name = name
+    @slug = slug
+    @project = project
+  end
+
+  def generate(data)
+    Wordsmith.client.post "projects/#{project.slug}/templates/#{slug}/outputs", data
+  end
+end

data/lib/wordsmith/template_collection.rb

@@ -0,0 +1,15 @@
+class Wordsmith::TemplateCollection
+
+  def initialize(templates)
+    @templates = templates
+  end
+
+  def find(slug)
+    template = @templates.find {|t| t.slug == slug }
+    template or fail %Q(Template not found with slug: "#{slug}")
+  end
+
+  def all
+    @templates.dup
+  end
+end

data/lib/wordsmith/version.rb

@@ -0,0 +1,3 @@
+module Wordsmith
+  VERSION = '1.0.2'
+end

data/wordsmith-ruby-sdk.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wordsmith/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wordsmith-ruby-sdk"
+  spec.version       = Wordsmith::VERSION
+  spec.authors       = ["Robert Tillery"]
+  spec.email         = ["rtillery@automatedinsights.com"]
+
+  spec.summary       = %q{Wordsmith SDK for Ruby}
+  spec.description   = %q{Provides API clients for Wordsmith.}
+  spec.homepage      = "https://github.com/AutomatedInsightsInc/wordsmith-ruby-sdk"
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "dotenv", "~> 2.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0"
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'hashie', '~> 3.4'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: wordsmith-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Robert Tillery
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Provides API clients for Wordsmith.
+email:
+- rtillery@automatedinsights.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".csslintrc"
+- ".env.example"
+- ".eslintignore"
+- ".eslintrc"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wordsmith-ruby-sdk.rb
+- lib/wordsmith/client.rb
+- lib/wordsmith/configuration.rb
+- lib/wordsmith/project.rb
+- lib/wordsmith/template.rb
+- lib/wordsmith/template_collection.rb
+- lib/wordsmith/version.rb
+- wordsmith-ruby-sdk.gemspec
+homepage: https://github.com/AutomatedInsightsInc/wordsmith-ruby-sdk
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wordsmith SDK for Ruby
+test_files: []