fixer_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b2804caf3476551d2e77e70a3f4522faec86a2d
-  data.tar.gz: 2dbed2d9c37d72811806071fe515de5689576641
+  metadata.gz: 3ba7944c758bde84335f90488ce2df501f68296d
+  data.tar.gz: 03a2fe995c0bc5dee65da83d3851e1dbdad80fe2
 SHA512:
-  metadata.gz: b6ef6ef9c05f6613645a5ed1151f8c04bec81c71db0a4995ac95c3e691dfb6325a450c2138bfb5ae4b5bfebfd45c59b8d772d8303ecca03da79e029273afb011
-  data.tar.gz: 8033f880b90362bee739fe5e3f4cf27c948d919a6c360f1eddcc2757706d24e21bd674fdd451e0f950757f9f95537025e595085cd15d4d39196cd4cfc8de782a
+  metadata.gz: 9400fd06d80dead91c5ca9ee03ab9c539db5f86728d8ba6f060a58f39bd06dee5c1a7471d651ea9e67edc9d74d64aa77810d2543553e1691b34bbb4a56f36c7a
+  data.tar.gz: cd5f5440e97e5f7525fefa905daedbb9df3cdd44c19dd8814c2a9c4823acad88d622ac3750eeb52e97472e5785c48b642174952e347970ad3650c49871887588

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,261 @@
+# from https://github.com/thoughtbot/hound/blob/114d4dfff8365e906d8b389f82d3ff9e0a47f747/config/style_guides/ruby.yml
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+AccessorMethodName:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 80
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/README.md

@@ -51,7 +51,6 @@ require 'fixer_client'
 
 client = Fixer::Client.new
 
-
 # list jobs
 js = client.jobs.list
 
@@ -82,6 +81,47 @@ j = client.jobs.create(job)
 
 ```
 
+You can also create jobs by dropping them on an SQS queue (assuming your fixer server is so configured):
+See the `examples/sqs_client.rb`:
+```
+Fixer.configure do |c|
+
+  # required: client_id identifies the application for this job
+  c.client_id = ''
+  c.client_secret = ''
+
+  # this is the default value
+  c.queue = 'production_fixer_job_create'
+
+  # optional: aws-sdk-core gem's config can be ENV vars, or in Fixer
+  c.aws = {
+    access_key_id: '',
+    secret_access_key: '',
+    region: 'us-east-1'
+  }
+end
+
+client = Fixer::SqsClient.new
+
+job = {
+  job: {
+    original: 's3://test-fixer/audio.wav',
+    job_type: 'audio',
+    tasks: [
+      {
+        task_type: 'transcode',
+        options: { format: 'mp3', bit_rate: 64, sample_rate: 44100 },
+        result: 's3://test-fixer/audio.mp3'
+      }
+    ]
+  }
+}
+
+# if not present, id is assigned to a GUID before sending to SQS
+new_job = client.create_job(job)
+puts "new job created with id: #{new_job.id}"
+```
+
 ## License
 [The MIT License](http://opensource.org/licenses/MIT)
 

data/examples/basic.rb

@@ -29,4 +29,5 @@ job = {
   }
 }
 
-j = client.jobs.create(job)
+new_job = client.jobs.create(job)
+puts "new job created: #{new_job.inspect}"

data/examples/sequence.rb

@@ -34,4 +34,5 @@ job = {
   }
 }
 
-j = client.jobs.create(job)
+new_job = client.jobs.create(job)
+puts "new job created: #{new_job.inspect}"

data/examples/sqs_client.rb

@@ -0,0 +1,42 @@
+require 'dotenv'
+Dotenv.load '.env-fixer_client'
+
+require 'fixer_client'
+Fixer.reset!
+
+# you also need AWS configured via ENV vars
+# id, secret, and region for aws-adk-core to work
+# AWS_ACCESS_KEY_ID
+# AWS_SECRET_ACCESS_KEY
+# AWS_REGION
+# or they can be config options under the :aws config
+# :access_key_id, :secret_access_key, and :region
+Fixer.configure do |c|
+  c.client_id = ENV['FIXER_CLIENT_ID']
+  c.client_secret = ENV['FIXER_CLIENT_SECRET']
+  c.queue = 'development_fixer_job_create'
+  # c.aws = {
+  #   access_key_id: 'AMADEUPKEYNOTREAL',
+  #   secret_access_key: '11111111111111111111111',
+  #   region: 'us-east-1'
+  # }
+end
+
+client = Fixer::SqsClient.new
+
+job = {
+  job: {
+    original: 's3://test-fixer/audio.wav',
+    job_type: 'audio',
+    tasks: [
+      {
+        task_type: 'transcode',
+        options: { format: 'mp3', bit_rate: 64, sample_rate: 44100 },
+        result: 's3://test-fixer/audio.mp3'
+      }
+    ]
+  }
+}
+
+new_job = client.create_job(job)
+puts "new job created with id: #{new_job.id}"

data/examples/transcode.rb

@@ -26,4 +26,5 @@ job = {
   }
 }
 
-j = client.jobs.create(job)
+new_job = client.jobs.create(job)
+puts "new job created: #{new_job.inspect}"

data/fixer_client.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('excon')
   spec.add_runtime_dependency('hashie')
   spec.add_runtime_dependency('activesupport')
+  spec.add_runtime_dependency('aws-sdk-core')
 
   spec.add_development_dependency('bundler', '~> 1.3')
   spec.add_development_dependency('rake')

data/lib/fixer/api.rb

@@ -19,13 +19,13 @@ module Fixer
       end
     end
 
-    def initialize(options={}, &block)
+    def initialize(options = {})
       apply_options(options)
       yield(self) if block_given?
     end
 
-    def apply_options(options={})
-      self.current_options ||= ActiveSupport::HashWithIndifferentAccess.new(Fixer.options)
+    def apply_options(options = {})
+      self.current_options ||= Fixer.options.with_indifferent_access
       self.current_options = current_options.merge(args_to_options(options))
       Configuration.keys.each do |key|
         send("#{key}=", current_options[key])
@@ -97,4 +97,4 @@ module Fixer
       end
     end
   end
-end
+end

data/lib/fixer/client.rb

@@ -2,10 +2,8 @@
 
 module Fixer
   class Client < API
-
     def jobs(params={}, &block)
       @jobs ||= ApiFactory.api('Fixer::Jobs', self, params, &block)
     end
-
   end
 end

data/lib/fixer/configuration.rb

@@ -8,7 +8,9 @@ module Fixer
       :client_secret,
       :adapter,
       :endpoint,
-      :user_agent
+      :user_agent,
+      :aws,
+      :queue
     ].freeze
 
     # Adapters are whatever Faraday supports - I like excon alot, so I'm defaulting it
@@ -20,6 +22,9 @@ module Fixer
     # The value sent in the http header for 'User-Agent' if none is set
     DEFAULT_USER_AGENT = "Fixer Ruby Gem #{Fixer::VERSION}".freeze
 
+    # sqs queue to write messages
+    DEFAULT_QUEUE = 'production_fixer_job_create'.freeze
+
     attr_accessor *VALID_OPTIONS_KEYS
 
     # Convenience method to allow for global setting of configuration options
@@ -50,6 +55,8 @@ module Fixer
       self.adapter       = DEFAULT_ADAPTER
       self.endpoint      = ENV['FIXER_ENDPOINT'] || DEFAULT_ENDPOINT
       self.user_agent    = DEFAULT_USER_AGENT
+      self.aws           = nil
+      self.queue         = ENV['FIXER_QUEUE'] || DEFAULT_QUEUE
       self
     end
   end

data/lib/fixer/jobs.rb

@@ -2,8 +2,6 @@
 
 module Fixer
   class Jobs < API
-    include Configuration
-
     def tasks(params={}, &block)
       @jobs ||= ApiFactory.api('Fixer::Tasks', self, params, &block)
     end

data/lib/fixer/sqs_client.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+require 'aws-sdk-core'
+
+module Fixer
+  class SqsClient
+    include Configuration
+
+    attr_accessor *Fixer::Configuration.keys
+
+    def create_job(job, opts = {})
+      job[:job][:id] ||= SecureRandom.uuid
+      job[:job][:client_id] ||= client_id
+
+      sqs_options = options.merge(opts)
+      sqs_queue = sqs_options[:queue]
+      conn = sqs(sqs_options[:aws])
+      queue_url = conn.get_queue_url(queue_name: sqs_queue).queue_url
+      conn.send_message(queue_url: queue_url, message_body: job.to_json)
+      job
+    end
+
+    def sqs(options = nil)
+      @sqs ||= Aws::SQS::Client.new(options)
+    end
+
+    def sqs=(sqs)
+      @sqs = sqs
+    end
+
+    def initialize(options = {})
+      apply_options(options)
+      yield(self) if block_given?
+    end
+
+    def apply_options(options = {})
+      current_options = Fixer.options.merge(options).with_indifferent_access
+      Fixer::Configuration.keys.each do |key|
+        send("#{key}=", current_options[key])
+      end
+    end
+  end
+end

data/lib/fixer/version.rb

@@ -1,3 +1,3 @@
 module Fixer
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/fixer.rb

@@ -7,6 +7,7 @@ require 'fixer/response'
 require 'fixer/api'
 require 'fixer/api_factory'
 require 'fixer/client'
+require 'fixer/sqs_client'
 require 'fixer/jobs'
 require 'dotenv'
 

data/test/fixer/sqs_client_test.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'minitest_helper'
+
+describe Fixer::SqsClient do
+  let(:client) { Fixer::SqsClient.new }
+
+  let(:job_params) do
+    {
+      job: {
+        job_type: 'test',
+        priority: 1,
+        retry_max: 10,
+        retry_delay: 300,
+        tasks: [
+          sequence: {
+            tasks: [
+              {
+                task_type: 'echo',
+                label: 'test1',
+                options: { foo: 'bar' },
+                call_back: 'http://cms.prx.dev/call_back'
+              },
+              {
+                task_type: 'echo',
+                label: 'test2',
+                options: { bar: 'foo' },
+                call_back: 'http://cms.prx.dev/call_back',
+                result: 'http://cms.prx.dev/echo.txt'
+              }
+            ]
+          }
+        ]
+      }
+    }
+  end
+
+  let(:sqs) do
+    queue = Minitest::Mock.new
+    queue.expect(:queue_url, 'http://sqs.us-east-1.aws.amazon.com/test_fixer_callback')
+
+    sqs = Minitest::Mock.new
+    sqs.expect(:get_queue_url, queue, [Hash])
+    sqs.expect(:send_message, true, [Hash])
+    sqs
+  end
+
+  it 'makes a new client' do
+    client.must_be_instance_of Fixer::SqsClient
+  end
+
+  it 'sets config' do
+    client.client_id.must_equal '1111111111111111111111111111111111111111111111111111111111111111'
+  end
+
+  it 'creates a complex job, sets id and client id' do
+    client.sqs = sqs
+    j = client.create_job(job_params)
+    j[:job][:id].wont_be_nil
+    j[:job][:client_id].wont_be_nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixer_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +228,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -221,6 +237,7 @@ files:
 - Rakefile
 - examples/basic.rb
 - examples/sequence.rb
+- examples/sqs_client.rb
 - examples/transcode.rb
 - fixer_client.gemspec
 - lib/fixer.rb
@@ -231,11 +248,13 @@ files:
 - lib/fixer/connection.rb
 - lib/fixer/jobs.rb
 - lib/fixer/response.rb
+- lib/fixer/sqs_client.rb
 - lib/fixer/tasks.rb
 - lib/fixer/version.rb
 - lib/fixer_client.rb
 - test/files/audio.wav
 - test/fixer/client_test.rb
+- test/fixer/sqs_client_test.rb
 - test/minitest_helper.rb
 homepage: https://github.org/PRX/fixer_client
 licenses:
@@ -264,4 +283,5 @@ summary: Client for the fixer application.
 test_files:
 - test/files/audio.wav
 - test/fixer/client_test.rb
+- test/fixer/sqs_client_test.rb
 - test/minitest_helper.rb