scripted_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60bbca440d11c0a5cc9df900fd46e73f09e2026b
+  data.tar.gz: 3afa43ce47b97c7507d063be64df2c63d8dc2ae7
+SHA512:
+  metadata.gz: 05cf9bcbc9764b0084f88501d87a796167394f30bc396fcfafb1dd08d6beb436e542545082bdedfe220110e8d79e615dea06c6e3308d9c7fb8a351fe780a3bfa
+  data.tar.gz: 1458ae1a84310c1a07ede9dca83aa7cabb4c0c0a46c22a0f3234f5cff251a520a1e165d08becdccf1329f6402e93ce0103b03cf29fb0433f9c835bb26b1d4a77

data/README.md

@@ -0,0 +1,100 @@
+# The Scripted API Client
+
+### Setup
+
+Install via RubyGems:
+
+    gem install scripted_client
+
+Or a Gemfile:
+
+    gem 'scripted_client'
+
+In an initializer, set up your account organization_key and access token. For example:
+
+    # config/initializers/scripted.rb
+    ScriptedClient.organization_key = 'orangutan'
+    ScriptedClient.access_token = 'make-great-pets'
+
+In production, make sure you set the environment to **:production**
+
+    ScriptedClient.env = :production
+
+Otherwise, it will be **:sandbox** by default. Contact us for a Sandbox Account!
+
+### Creating a Job
+
+First, find a JobTemplate that you'd like to use:
+
+    templates = ScriptedClient::JobTemplate.all
+    blog_post = templates.find { |template| template.name == 'Standard Blog Post' }
+
+Next, assign some values for the Prompts on that JobTemplate. Prompts are question/answer pairs that help guorganization_keye your writer. They can be one of five kinds: `string[255]` `string[1024]` `radio` `checkbox` `array`. The data type of the `value` that you post will depend on the kind of the Prompt:
+
+| Kind         | Value Type                    | Has `value_options`? |
+|--------------|-------------------------------|----------------------|
+| string[255]  | String (max. 255 characters)  | No                   |
+| string[1024] | String (max. 1024 characters) | No                   |
+| radio        | String                        | Yes                  |
+| checkbox     | Array                         | Yes                  |
+| array        | Array                         | No                   |
+
+If the prompt has `value_options` the `value` you pick has to be one of them.
+
+Here's how you might update a couple of prompt values:
+
+    sample_blog = blog_post.prompts.find { |prompt| prompt.label == 'Sample Blog' }
+    sample_blog.value = 'https://scripted.com/blogs/'
+    goal = blog_post.prompts.find { |prompt| prompt.label == 'Goal' }
+    goal.value = ['Informed analysis']
+    key_points = blog_post.prompts.find { |prompt| prompt.label == 'Key Points' }
+    key_points.value = ['Orangutans make great pets', 'Normal pets are lame']
+
+Next, you can find an Industry:
+
+    industries = ScriptedClient::Industry.all
+    lifestyle = industries.find { |industry| industry.name == 'Lifestyle & Travel' }
+
+Now you can create the Job!
+
+    job = ScriptedClient::Job.new(
+      topic: 'Top 10 Reasons to Buy an Orangutan',
+      job_template: blog_post,
+      industries: [lifestyle]
+    )
+    job.save
+    # => true
+
+**Protip** If `job.save` returns `false` use `job.errors.full_messages` to see what went wrong.
+
+### Retrieving Jobs
+
+Get all jobs using `ScriptedClient::Job.all`, or be a bit more specific using any of these scopes:
+
+    screening writing draft_ready revising final_ready in_progress needs_review accepted rejected finished
+
+For example:
+
+    jobs = ScriptedClient::Job.needs_review
+
+There are also scopes on Pitchset: `open`, `closed` and `requires_action`.
+
+If the collection has a next page:
+
+    jobs = ScriptedClient::Job.all
+    jobs.has_next?
+    # => true
+
+you can retrieve that next page using `next`:
+
+    jobs = ScriptedClient::Job.all
+    page_two = jobs.next
+
+If you'd like to review the written content itself, use the `html_contents` method:
+
+    job = ScriptedClient::Job.first
+    job.html_contents
+
+### Development
+
+From within this directory, `bundle install` and run `rspec` to execute the tests. If you want to use the gem against a local version of the API, set `ScriptedClient.env = :development`.

data/lib/scripted_client.rb

@@ -0,0 +1,79 @@
+module ScriptedClient
+  API_VERSION = 'v1'
+  @@access_token, @@organization_key = nil, nil
+  @@env = :sandbox
+
+  def self.access_token
+    @@access_token || fail("You must set #{ name }.access_token")
+  end
+
+  def self.access_token=(_access_token)
+    @@access_token = _access_token
+    reset_resource_site
+    @@access_token
+  end
+
+  def self.organization_key
+    @@organization_key || fail("You must set #{ name }.organization_key")
+  end
+
+  def self.organization_key=(_organization_key)
+    @@organization_key = _organization_key
+    reset_resource_site
+    @@organization_key
+  end
+
+  def self.env
+    @@env
+  end
+
+  def self.env=(_env)
+    unless [:development, :sandbox, :production].include?(_env)
+      fail "#{ name }.env must be either :sandbox or :production"
+    end
+    @@env = _env
+    reset_resource_site
+    @@env
+  end
+
+  def self.base_host
+    case env
+    when :sandbox
+      'scripted-sandbox.herokuapp.com'
+    when :production
+      'api.scripted.com'
+    when :development
+      'localhost:3000'
+    end
+  end
+
+  def self.protocol
+    env == :development ? 'http' : 'https'
+  end
+
+  def self.base_url
+    "#{ protocol }://#{ base_host }"
+  end
+
+  def self.prefix
+    "/#{ organization_key }/#{ API_VERSION }/"
+  end
+
+  def self.reset_resource_site
+    if @@organization_key && @@access_token
+      ScriptedClient::Resource.site = base_url
+      ScriptedClient::Resource.prefix = prefix
+      ScriptedClient::Resource.descendants.each(&:setup_prefix)
+      ScriptedClient::Resource.headers['Authorization'] = "Bearer #{ access_token }"
+    end
+  end
+end
+
+require 'active_resource'
+require 'scripted_client/collection'
+require 'scripted_client/resource'
+require 'scripted_client/job'
+require 'scripted_client/job_template'
+require 'scripted_client/industry'
+require 'scripted_client/pitch'
+require 'scripted_client/pitchset'

data/lib/scripted_client/collection.rb

@@ -0,0 +1,24 @@
+module ScriptedClient
+  class Collection < ActiveResource::Collection
+
+    attr_accessor :next_page
+
+    def initialize(parsed = {})
+      @elements = parsed['data']
+      paging = parsed['paging']
+      @next_page = paging['next_cursor'] if paging && paging['has_next']
+    end
+
+    def next
+      fail 'No more pages' unless has_next?
+      resource_class.all(
+        params: original_params.merge(next_cursor: next_page)
+      )
+    end
+
+    def has_next?
+      next_page.present?
+    end
+
+  end
+end

data/lib/scripted_client/industry.rb

@@ -0,0 +1,10 @@
+module ScriptedClient
+  class Industry < Resource
+
+    # Caching because industries never change
+    def self.all(*args)
+      @@all ||= super
+    end
+
+  end
+end

data/lib/scripted_client/job.rb

@@ -0,0 +1,20 @@
+module ScriptedClient
+  class Job < Resource
+    define_filter_methods(%w(
+      screening
+      writing
+      draft_ready
+      revising
+      final_ready
+      in_progress
+      needs_review
+      accepted
+      rejected
+      finished))
+
+    def html_contents
+      get(:html_contents)['html_contents']
+    end
+
+  end
+end

data/lib/scripted_client/job_template.rb

@@ -0,0 +1,4 @@
+module ScriptedClient
+  class JobTemplate < Resource
+  end
+end

data/lib/scripted_client/pitch.rb

@@ -0,0 +1,36 @@
+module ScriptedClient
+  class Pitch < Resource
+    def self.find(*arguments)
+      if arguments.first.kind_of?(String)
+        options = arguments[1]
+        unless options.kind_of?(Hash) &&
+          options[:params].kind_of?(Hash) &&
+          options[:params].key?(:pitchset_id)
+          fail "You must pass both a pitchset_id and an id to #{ name }#find. For example: \n
+            #{ name }.find('#{ arguments.first }', params: { pitchset_id: 'abc123' }) \n\n\n"
+        end
+      end
+      super
+    end
+
+    def self.setup_prefix
+      self.prefix = "#{ prefix }pitchsets/:pitchset_id/"
+    end
+
+    def accept(feedback = nil)
+      set_pitchset_prefix
+      post(:accept, {}, { feedback: feedback }.to_json)
+    end
+
+    def reject(feedback = nil)
+      set_pitchset_prefix
+      post(:reject, {}, { feedback: feedback }.to_json)
+    end
+
+    private
+
+    def set_pitchset_prefix
+      self.prefix_options[:pitchset_id] = pitchset.id
+    end
+  end
+end

data/lib/scripted_client/pitchset.rb

@@ -0,0 +1,6 @@
+module ScriptedClient
+  class Pitchset < Resource
+    define_filter_methods(%w(open closed requires_action))
+    has_many :pitches, class_name: 'scripted_client/pitch'
+  end
+end

data/lib/scripted_client/resource.rb

@@ -0,0 +1,26 @@
+module ScriptedClient
+  class Resource < ActiveResource::Base
+    self.format = :json
+    self.collection_parser = ScriptedClient::Collection
+
+    # Some tasteful meta-programming to define
+    # filter methods, for example:
+    ### ScriptedClient::Job.needs_review
+    def self.define_filter_methods(filters)
+      filters.each do |filter|
+        define_singleton_method(filter) do
+          all(params: { filter: filter })
+        end
+      end
+    end
+
+    def self.site
+      super if ScriptedClient.organization_key && ScriptedClient.access_token
+    end
+
+    # A hook for any nested resources
+    # (see ScriptedClient::Pitch for implementation)
+    def self.setup_prefix; end
+
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: scripted_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jake Kring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: Provides a simple wrapper for creating, listing and reviewing Scripted.com
+  Jobs and Pitches.
+email: jake@scripted.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/scripted_client.rb
+- lib/scripted_client/collection.rb
+- lib/scripted_client/industry.rb
+- lib/scripted_client/job.rb
+- lib/scripted_client/job_template.rb
+- lib/scripted_client/pitch.rb
+- lib/scripted_client/pitchset.rb
+- lib/scripted_client/resource.rb
+homepage: http://rubygems.org/gems/scripted_client
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A client to consume the Scripted.com API
+test_files: []