authorr-api 1.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjcwMWM5Y2MxMGViN2MxNWUzNWRiNTMyM2Q5Y2MzMzE1ZTI3MmIyNg==
+  data.tar.gz: !binary |-
+    NDI1NDU1OWI3M2ZiNDE3NTQ4MjE5NDU4NTU0MDg0N2U0MzVmZTQ0YQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZWQ2OTI1Zjc0ODNjNDE4YTg4NjE4OTA3NGU2NTlkNzA1NmFhNjgzNWEyY2My
+    ZGI1NGFjYzI0MDhjY2UwNzc0ZjU2ZDk0OWRlN2MwZWJiNDZmYWRkNDgyOWY4
+    YmU5MzcwYmY4YmJkZDEwZTE3OGI4OTdmYjQxYTliZWM5NTliMjU=
+  data.tar.gz: !binary |-
+    MGYzYjMxMDgzOWI0MzRjNmVmN2JkMDRkMDFiY2FmODc3YTQ0ZDczNjMxNWFm
+    OTM2YTcyMzNhOTE4MDRjOWFiNDNjMWVjYmI1NjU3MWQxZjFjMmZjZTc2Yzdj
+    N2UxMGNhMGY1MWNjZDc4YTE1NjQ2Zjg2MWVjMTEzYmVhZTA0NmU=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Velluto
+
+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,34 @@
+# Authorr API
+
+This library is used to access The Authorr API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'authorr-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authorr-api
+
+## Usage
+
+Include the gem on your project and use it like this:
+
+    require 'authorr-api'
+    
+    api = AuthorrCustomer.new('<api_key>')
+    api.desired_method
+  
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/authorr-api.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/authorr-api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Velluto"]
+  gem.email         = ["authorr@authorr.com"]
+  gem.description   = %q{Authorr API for Customers and Authors}
+  gem.summary       = %q{Authorr API}
+  gem.homepage      = "http://www.authorr.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "authorr-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Authorr::Api::VERSION
+end

data/lib/authorr-api.rb

@@ -0,0 +1,4 @@
+require "authorr-api/version"
+require "authorr-api/customers"
+require "authorr-api/authors"
+

data/lib/authorr-api/customers.rb

@@ -0,0 +1,147 @@
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+class AuthorrCustomer
+  class AuthorrCustomerException < RuntimeError
+  end
+
+  def initialize(api_key, base_path = nil)
+    @base_path = base_path || 'http://app.authorr.com'
+    @api_key = api_key
+  end
+
+  def exec_get(uri)
+    uri = URI(uri)
+    result = Net::HTTP.get_response(uri)
+    if result.is_a?(Net::HTTPSuccess)
+      JSON.parse(result.body)
+    else
+      raise AuthorrCustomerException.new result.body
+    end
+  end
+
+  def exec_post(parameters, method, uri)
+    uri = URI(uri)
+    req = case method
+            when 'put'
+              Net::HTTP::Put.new(uri.request_uri)
+            when 'post'
+              Net::HTTP::Post.new(uri.request_uri)
+            when 'delete'
+              Net::HTTP::Delete.new(uri.request_uri)
+            end
+    req.body = JSON.dump(parameters)
+    req.content_type = "application/json"
+    result = Net::HTTP.start(uri.hostname, uri.port) do |http|
+      http.request(req)
+    end
+    #result = Net::HTTP.post_form(uri, converted_params)
+    if result.is_a?(Net::HTTPSuccess)
+      if result.body == 'false'
+        false
+      elsif result.body == 'true'
+        true
+      else
+        if method != 'delete'
+          JSON.parse(result.body)
+        else
+          result.body
+        end
+      end
+    else
+      raise AuthorrCustomerException.new result.body
+    end
+  end
+
+
+  # This method creates a new Order.
+  # Parameters:
+  # - assignments: List of assignments
+  # - min_rating: Minimum rating for author
+  # - name: 
+  def create_order(assignments, min_rating = nil, name = nil)
+    if assignments.nil?
+      raise AuthorrCustomerException.new('assignments should not be empty')
+    end
+    parameters = {'order' => {'assignments' => assignments, 'min_rating' => min_rating, 'name' => name}}
+    exec_post(parameters, 'post', "#{@base_path}/api/v1/customers/orders.json?api_key=#{@api_key}")
+  end
+
+  # This method returns all your orders.
+  # Parameters:
+  #  none
+  def get_orders()
+    exec_get("#{@base_path}/api/v1/customers/orders.json?api_key=#{@api_key}")
+  end
+
+  # Returns the details of a specific order. Use this to check the status of your orders.
+  # Parameters:
+  # - id: Order ID
+  def get_order_by_id(id)
+    if id.nil?
+      raise AuthorrCustomerException.new('id should not be empty')
+    end
+    exec_get("#{@base_path}/api/v1/customers/orders/#{id}.json?api_key=#{@api_key}")
+  end
+
+  # Retrieves information about a single assignment.
+  # Parameters:
+  # - id: Assignment ID
+  def get_assignment_by_id(id)
+    if id.nil?
+      raise AuthorrCustomerException.new('id should not be empty')
+    end
+    exec_get("#{@base_path}/api/v1/customers/assignments/#{id}.json?api_key=#{@api_key}")
+  end
+
+  # Use this method to resubmit a rejected assignment. You should provide instructions along with your request
+  # for the author.
+  # Parameters:
+  # - id: Assignment ID
+  # - instructions: Instructions for Author
+  # - topic: Topic to write about
+  # - required_words_for_title: Required Words for Title (space separated)
+  # - required_keywords: Required Keywords (comma separated)
+  def resubmit_assignment(id, instructions, topic = nil, required_words_for_title = nil, required_keywords = nil)
+    if id.nil?
+      raise AuthorrCustomerException.new('id should not be empty')
+    end
+
+    if instructions.nil?
+      raise AuthorrCustomerException.new('instructions should not be empty')
+    end
+    parameters = {'instructions' => instructions, 'topic' => topic, 'required_words_for_title' => required_words_for_title, 'required_keywords' => required_keywords}
+    exec_post(parameters, 'put', "#{@base_path}/api/v1/customers/assignments/#{id}/resubmit.json?api_key=#{@api_key}")
+  end
+
+  # Use this method to request an edit to a delivered assignment. You should provide instructions along with your request
+  # for the author.
+  # Parameters:
+  # - id: Assignment ID
+  # - instructions: Edit instructions for the author
+  def request_assignment_edit(id, instructions)
+    if id.nil?
+      raise AuthorrCustomerException.new('id should not be empty')
+    end
+
+    if instructions.nil?
+      raise AuthorrCustomerException.new('instructions should not be empty')
+    end
+    parameters = {'instructions' => instructions}
+    exec_post(parameters, 'put', "#{@base_path}/api/v1/customers/assignments/#{id}/request_edit.json?api_key=#{@api_key}")
+  end
+
+  # Use this method to accept an assignment.
+  # Parameters:
+  # - id: Assignment ID
+  def accept_assignment(id)
+    if id.nil?
+      raise AuthorrCustomerException.new('id should not be empty')
+    end
+    parameters = {}
+    exec_post(parameters, 'put', "#{@base_path}/api/v1/customers/assignments/#{id}/accept_assignment.json?api_key=#{@api_key}")
+  end
+
+end

data/lib/authorr-api/version.rb

@@ -0,0 +1,5 @@
+module Authorr
+  module Api
+    VERSION = "1.0.1"
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: authorr-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Velluto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-22 00:00:00.000000000 Z
+dependencies: []
+description: Authorr API for Customers and Authors
+email:
+- authorr@authorr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- authorr-api.gemspec
+- lib/authorr-api.rb
+- lib/authorr-api/customers.rb
+- lib/authorr-api/version.rb
+homepage: http://www.authorr.com
+licenses: []
+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: Authorr API
+test_files: []
+has_rdoc: