wordsmith-ruby-sdk 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e04d2f0401f1753648c5cff6a9bcf95d4c712eba
-  data.tar.gz: 5142657050d39066695ee10c2ad8453c961ae22f
+  metadata.gz: e2edee3b154385fe36ade8499a071212527b1434
+  data.tar.gz: 3deb82adbe6a5d1baf0e5b35a59ef9d8cd42bb36
 SHA512:
-  metadata.gz: bf191499ee860d310551d10be52aa6c345f6d99a86a79d616605078309cc709f1af1fe5d303bbbfd1d2c1b53aa1d8b4265bd7ed0773d78411ba007362e78e063
-  data.tar.gz: 6601d1f7dd3b14d310b5d27afa96ef8eda5966b05f04b440a5e98cb4e9534c44998ea97463279fc0621aaa6a6253f6858beba3526703c1433ee89f5eaaee2ef5
+  metadata.gz: 7e4e68946fb9b84b1639e653ac105dfda79e9d9a9b89033fd1bad200f7c8ee0abce9ff0a92f983bf076cd60cff186b9c8e7b408637e60fd686b2478d77609dce
+  data.tar.gz: 92b41f79265180979fbd1234741c25419992d7f795dea0a3dc672a6b27f2744c17c35a96ceb7832deff417f4845145a5387cb625dabdb424110b7536919dc374

data/.rubocop.yml

@@ -313,58 +313,6 @@ Performance/StringReplacement:
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code'
   Enabled: true
 
-##################### Rails ##################################
-
-Rails/ActionFilter:
-  Description: 'Enforces consistent use of action filter methods.'
-  Enabled: false
-
-Rails/Date:
-  Description: >-
-                  Checks the correct usage of date aware methods,
-                  such as Date.today, Date.current etc.
-  Enabled: false
-
-Rails/Delegate:
-  Description: 'Prefer delegate method for delegations.'
-  Enabled: false
-
-Rails/FindBy:
-  Description: 'Prefer find_by over where.first.'
-  Enabled: false
-
-Rails/FindEach:
-  Description: 'Prefer all.find_each over all.find.'
-  Enabled: false
-
-Rails/HasAndBelongsToMany:
-  Description: 'Prefer has_many :through to has_and_belongs_to_many.'
-  Enabled: false
-
-Rails/Output:
-  Description: 'Checks for calls to puts, print, etc.'
-  Enabled: false
-
-Rails/ReadWriteAttribute:
-  Description: >-
-                 Checks for read_attribute(:attr) and
-                 write_attribute(:attr, val).
-  Enabled: false
-
-Rails/ScopeArgs:
-  Description: 'Checks the arguments of ActiveRecord scopes.'
-  Enabled: false
-
-Rails/TimeZone:
-  Description: 'Checks the correct usage of time zone aware methods.'
-  StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time'
-  Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
-  Enabled: false
-
-Rails/Validation:
-  Description: 'Use validates :attribute, hash of validations.'
-  Enabled: false
-
 ################## Style #################################
 
 Style/AccessModifierIndentation:
@@ -528,11 +476,6 @@ Style/DefWithParentheses:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
   Enabled: false
 
-Style/DeprecatedHashMethods:
-  Description: 'Checks for use of deprecated Hash methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-key'
-  Enabled: false
-
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: false
@@ -716,7 +659,7 @@ Style/LineEndConcatenation:
                  line end.
   Enabled: false
 
-Style/MethodCallParentheses:
+Style/MethodCallWithoutArgsParentheses:
   Description: 'Do not use parentheses for method calls with no arguments.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens'
   Enabled: false

data/CHANGELOG.md

@@ -1,8 +1,9 @@
 # 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.4...HEAD)
+## [Unreleased](https://github.com/automatedinsightsinc/wordsmith-ruby-sdk/compare/v1.0.5...HEAD)
 
+##### Changed
 ## [1.0.5](https://github.com/automatedinsightsinc/wordsmith-ruby-sdk/compare/v1.0.4...v1.0.5)
 ##### Changed
 - Return :errors from Wordsmith when HTTP response code is 400 
@@ -20,8 +21,6 @@ All notable changes to this project will be documented in this file. This projec
 ##### 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

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+#### Background context for this PR
+
+#### What does this PR do?
+- [x] Something that's complete
+- [ ] Something that's still in progress
+
+#### Impacted areas in application
+- A page affected
+- A library affected
+
+#### How should PR reviewers test this?
+- Unit tests:
+  - `rake` (...OR replace with specific test files to run)
+- Manual tests:
+  - What features need to be on or off?
+  - Detailed description of how to reproduce
+  - ...what page
+  - ...test data
+  - ...etc
+
+#### Would you like specific feedback on anything?

data/README.md

@@ -39,20 +39,27 @@ Configure in initializer or as desired
 #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
+  config.version = '1' #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
+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
+
+# Fetch a template by slug.
+template = project.templates.find('template-slug')
 
-project.schema     #the data schema for the project
-project.templates  #a collection of templates for this project
+# Test your implementation without being charged for producing content.
+template.test({a_data_point: 1, another_one: 'Tuesday'})                       
+ > nil # if no errors found, otherwise return RuntimeError
 
-template = project.templates.find('template-slug')           #fetch a template by slug
-template.generate({a_data_point: 1, another_one: 'Tuesday'}) #generate content
+# Generate your narrative. 
+template.generate({a_data_point: 1, another_one: 'Tuesday'}, proofread: false)
  > {content: 'Your content is here!'}
 ```
 

data/Rakefile

@@ -8,3 +8,7 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/*_test.rb']
 #  t.options = '--verbose'
 end
+
+task :console do
+  exec "irb -r wordsmith-ruby-sdk -I ./lib"
+end

data/lib/wordsmith/client.rb

@@ -6,24 +6,31 @@ module Wordsmith
   class Client
 
     def get(uri)
-      response = connection.get uri
-      parse_response response
+      response = connection.get(uri)
+      parse_response(response)
     end
 
-    def post(uri, data)
-      response = connection.post uri, {data: data}.to_json
-      parse_response response
+    def post(uri, data, proofread:)
+      response = connection.post(uri, {data: data, proofread: proofread}.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
-      })
+      @_connection = initialize_connection
+    end
+
+    def initialize_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?
@@ -31,24 +38,23 @@ module Wordsmith
       url = @_connection.url_prefix.to_s
       authorization = @_connection.headers['Authorization']
 
-      url == Wordsmith.configuration.url &&
-        authorization == "Bearer #{Wordsmith.configuration.token}"
+      url == Wordsmith.configuration.url && valid_token?(authorization)
+    end
+
+    def valid_token?(authorization)
+      authorization == "Bearer #{Wordsmith.configuration.token}"
     end
 
     def parse_response(response)
       body = JSON.parse(response.body)
-      Hashie.symbolize_keys! body
+      Hashie.symbolize_keys!(body)
       case response.status
-      when 200, 201
-        return body[:data]
-      when 400
-        fail %Q(Bad Request: "#{body[:errors]}")
-      when 401
-        fail 'API authorization error'
-      when 429
-        fail body[:error]
-      else
-        fail 'API error'
+      when 200, 201 then body[:data]
+      when 400 then raise(%Q(Bad Request: "#{body[:errors]}"))
+      when 401 then raise('API authorization error.')
+      when 404 then raise('Incorrect version set in wordsmith.rb')
+      when 429 then raise(body[:error])
+      else raise('API error')
       end
     end
   end

data/lib/wordsmith/configuration.rb

@@ -1,13 +1,19 @@
 module Wordsmith
   class Configuration
-    attr_accessor :token, :url, :user_agent
-    DEFAULT_URL = 'https://api.automatedinsights.com/v1'
+    attr_accessor :token, :user_agent, :version
+    DEFAULT_VERSION = '1'
     DEFAULT_USER_AGENT = "RubySDK/#{Wordsmith::VERSION}"
+    URL_HOST = 'https://api.automatedinsights.com'
+    DEFAULT_URL = "#{URL_HOST}/v#{DEFAULT_VERSION}"
 
     def initialize
-      @url = DEFAULT_URL
+      @version = DEFAULT_VERSION
       @user_agent = DEFAULT_USER_AGENT
     end
+
+    def url
+      "#{URL_HOST}/v#{version}"
+    end
   end
 
   module_function

data/lib/wordsmith/project.rb

@@ -1,24 +1,28 @@
-class Wordsmith::Project
-  attr_reader :name, :slug, :schema, :templates
+module Wordsmith
+  class Project
+    attr_reader :name, :slug, :schema, :templates
 
-  def self.all
-    projects_attributes = Wordsmith.client.get 'projects'
-    projects_attributes.map {|p| new(**p)}
-  end
+    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 self.find(slug)
+      project = all.find { |p| p.slug == slug }
+      project || raise(%Q(Project not found with slug: "#{slug}"))
+    end
 
-  private
+    private
 
-  def initialize(name: nil, slug: nil, schema: nil, templates: nil, **attributes)
-    raise "Missing required keyword arguments" unless [name, slug, templates].all?
-    @name = name
-    @slug = slug
-    @schema = schema
-    @templates = Wordsmith::TemplateCollection.new(
-      templates.map {|t| Wordsmith::Template.new project: self, **t})
+    def initialize(name: nil, slug: nil, schema: nil, templates: nil, **attributes)
+      raise 'Missing required keyword arguments' unless [name, slug, templates].all?
+      @name = name
+      @slug = slug
+      @schema = schema
+      @templates =
+        Wordsmith::TemplateCollection.new(
+          templates.map { |t| Wordsmith::Template.new(project: self, **t) }
+        )
+    end
   end
 end

data/lib/wordsmith/template.rb

@@ -1,14 +1,26 @@
-class Wordsmith::Template
-  attr_reader :name, :slug, :project
-
-  def initialize(name: nil, slug: nil, project: nil, **attributes)
-    raise "Missing required keyword arguments" unless [name, slug, project].all?
-    @name = name
-    @slug = slug
-    @project = project
-  end
+module Wordsmith
+  class Template
+    attr_reader :name, :slug, :project
+
+    def initialize(name: nil, slug: nil, project: nil, **attributes)
+      raise 'Missing required keyword arguments' unless [name, slug, project].all?
+      @name = name
+      @slug = slug
+      @project = project
+    end
+
+    def generate(data, proofread: false)
+      Wordsmith.client.post(path('outputs'), data, proofread: proofread)
+    end
+
+    def test(data, proofread: false)
+      Wordsmith.client.post(path('test'), data, proofread: proofread)
+    end
+
+    private
 
-  def generate(data)
-    Wordsmith.client.post "projects/#{project.slug}/templates/#{slug}/outputs", data
+    def path(endpoint)
+      "projects/#{project.slug}/templates/#{slug}/#{endpoint}"
+    end
   end
 end

data/lib/wordsmith/template_collection.rb

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

data/lib/wordsmith/version.rb

@@ -1,3 +1,3 @@
 module Wordsmith
-  VERSION = '1.0.5'
+  VERSION = '2.0.0'
 end

data/wordsmith-ruby-sdk.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wordsmith/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wordsmith-ruby-sdk"
+  spec.name          = 'wordsmith-ruby-sdk'
   spec.version       = Wordsmith::VERSION
-  spec.authors       = ["Robert Tillery"]
-  spec.email         = ["rtillery@automatedinsights.com"]
+  spec.authors       = ['Robert Tillery', 'Jonathan Gaegler']
+  spec.email         = ['jong@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.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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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_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'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: wordsmith-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Robert Tillery
+- Jonathan Gaegler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +111,7 @@ dependencies:
         version: '3.4'
 description: Provides API clients for Wordsmith.
 email:
-- rtillery@automatedinsights.com
+- jong@automatedinsights.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -125,6 +126,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
 - bin/console
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Wordsmith SDK for Ruby