amara 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8510ef4c28f4fe621d93af3e766474f0cfae1059
-  data.tar.gz: 5fb1800d65cbd59a5b1b51b34b6793cfb6ead749
+  metadata.gz: 144c53baf060dded67c646c85f51a52dac9582f4
+  data.tar.gz: 727735380c694fea5311ee26a584b0356d9bc1a7
 SHA512:
-  metadata.gz: b1517cbc3df344f5ec6dd0f7a5485bd75f183d54b785f10fbcd576ad286daf6f4e562e5d6682fe5b3e3c1dda422464da133569b03b01eb160d0a404b61620604
-  data.tar.gz: 7e0bd035c547bc960283bb145d02eadaa3aa5fccc8a56ff51b19402a9c2f1e53047c26fda13faaf745da1be0f597d964984327a47c12bf2b51357e24cd77b7e4
+  metadata.gz: 9b5f3a15c7489353a09d7d7858e4d420ef54ed24a7375b5b4267b8613772f03fee6bd8ca8c6747f5478b0911a2ff1b1173f4f81701bda9ab3171eb15dc83a2bc
+  data.tar.gz: 7e9432906468f09cd4d4a2e15699b8b0a716cc3f26621081b4b09c00f01866a78989645176c6bba04c4af28bd4c3f232e3543d5206f1b14508cdeedf7eb35b50

data/.gitignore

@@ -1,3 +1,5 @@
+.DS_Store
+.ruby-version
 *.gem
 *.rbc
 .bundle

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.3
+  - 2.2
 notifications:
   email:
     - andrew@prx.org

data/README.md

@@ -104,6 +104,14 @@ new_team = amara.teams.create(
 
 ```
 
+In the event of an error from the Amara service, the error will be wrapped in one of the following exception clases.
+```ruby
+raise Amara::NotFoundError # 404 error
+raise Amara::ClientError # All other 400 errors
+raise Amara::ServerError # 500 errors
+raise Amara::UnknownError # All other errors
+```
+
 ## Contributing
 
 1. Fork it

data/lib/amara.rb

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'active_support/all'
 
 require 'amara/version'
+require 'amara/errors'
 require 'amara/configuration'
 require 'amara/connection'
 require 'amara/response'
@@ -18,6 +19,7 @@ require 'amara/videos/languages'
 require 'amara/videos/languages/subtitles'
 require 'amara/videos/urls'
 require 'amara/activity'
+require 'amara/path'
 require 'amara/client'
 
 module Amara
@@ -42,5 +44,4 @@ module Amara
     :managers => 'Managers and admins',
     :admins   => 'Admins only'
   }
-
 end

data/lib/amara/api.rb

@@ -36,19 +36,42 @@ module Amara
         raise ArgumentError, "whoops, that isn't a valid http method: #{method}"
       end
 
-      conn = connection((params[:options] || {}).merge(current_options))
-      request_path = (conn.path_prefix + '/' + path + '/').gsub(/\/+/, '/') 
+      options = current_options.merge(params[:options] || {})
+      request_params = params.except(:options)
+      conn = connection(options)
+      request_path = (conn.path_prefix + '/' + path + '/').gsub(/\/+/, '/')
 
       response = conn.send(method) do |request|
         case method.to_sym
         when :get, :delete
-          request.url(request_path, params)
+          request.url(request_path, request_params)
         when :post, :put
           request.path = request_path
-          request.body = params[:data] ? params[:data].to_json : nil
+          request.body = request_params[:data] ? request_params[:data].to_json : nil
         end
       end
-      Amara::Response.new(response, {api: self, method: method, path: path, params: params})
+
+      amara_response = Amara::Response.new(response, { api: self, method: method, path: path, params: params } )
+      check_for_error(response) if options[:raise_errors]
+      amara_response
+    end
+
+    def check_for_error(response)
+      status_code_type = response.status.to_s[0]
+      case status_code_type
+      when "2"
+        # puts "all is well, status: #{response.status}"
+      when "4"
+        if response.status == 404
+          raise NotFoundError.new("Resource not found", response)
+        else
+          raise ClientError.new("Whoops, error back from Amara: #{response.status}", response)
+        end
+      when "5"
+        raise ServerError.new("Whoops, error back from Amara: #{response.status}", response)
+      else
+        raise UnknownError.new("Unrecongized status code: #{response.status}", response)
+      end
     end
 
     def base_path
@@ -64,7 +87,7 @@ module Amara
     end
 
     def paginate(params={})
-      {limit: 20, offset: 0}.merge(params)
+      params.reverse_merge(limit: 20, offset: 0)
     end
 
     def list(params={})
@@ -72,26 +95,46 @@ module Amara
       request(:get, base_path, paginate(params))
     end
 
+    def list!(params={})
+      list(force_raise_errors(params))
+    end
+
     def get(params={})
       self.current_options = current_options.merge(args_to_options(params))
       request(:get, base_path)
     end
 
+    def get!(params={})
+      get(force_raise_errors(params))
+    end
+
     def create(params={})
       self.current_options = current_options.merge(args_to_options(params))
       request(:post, base_path, {data: params})
     end
 
+    def create!(params={})
+      create(force_raise_errors(params))
+    end
+
     def update(params={})
       self.current_options = current_options.merge(args_to_options(params))
       request(:put, base_path, {data: params})
     end
 
+    def update!(params={})
+      update(force_raise_errors(params))
+    end
+
     def delete(params={})
       self.current_options = current_options.merge(args_to_options(params))
       request(:delete, base_path)
     end
 
+    def delete!(params={})
+      delete(force_raise_errors(params))
+    end
+
     def args_to_options(args)
       params =  if args.is_a?(String) || args.is_a?(Symbol)
         {"#{self.class.name.demodulize.downcase.singularize}_id" => args}
@@ -99,5 +142,12 @@ module Amara
         args
       end
     end
+
+    def force_raise_errors(params)
+      (params || {}).with_indifferent_access.tap do |p|
+        p[:options] = ActiveSupport::HashWithIndifferentAccess.new(p[:options])
+        p[:options][:raise_errors] = true
+      end
+    end
   end
 end

data/lib/amara/client.rb

@@ -27,5 +27,10 @@ module Amara
       @users ||= ApiFactory.api('Amara::Users', self, params, &block)
     end
 
+    def path(path, params={}, &block)
+      @path ||= ApiFactory.api('Amara::Path', self, params, &block)
+      @path.current_options['path'] = path
+      @path
+    end
   end
 end

data/lib/amara/configuration.rb

@@ -8,7 +8,8 @@ module Amara
       :api_key,
       :adapter,
       :endpoint,
-      :user_agent
+      :user_agent,
+      :raise_errors
     ].freeze
 
     # this you need to get from amara - go register!
@@ -24,6 +25,9 @@ module Amara
     # The value sent in the http header for 'User-Agent' if none is set
     DEFAULT_USER_AGENT = "Amara Ruby Gem #{Amara::VERSION}".freeze
 
+    # by default, raise errors instead of returning them
+    DEFAULT_RAISE_ERRORS = true
+
     attr_accessor *VALID_OPTIONS_KEYS
 
     # Convenience method to allow for global setting of configuration options
@@ -54,8 +58,8 @@ module Amara
       self.adapter      = DEFAULT_ADAPTER
       self.endpoint     = DEFAULT_ENDPOINT
       self.user_agent   = DEFAULT_USER_AGENT
+      self.raise_errors = DEFAULT_RAISE_ERRORS
       self
     end
-
   end
-end
+end

data/lib/amara/errors.rb

@@ -0,0 +1,16 @@
+module Amara
+
+  class Error < ::StandardError
+    attr_accessor :response
+
+    def initialize(message = nil, response = nil)
+      super(message || "Amara Error")
+      self.response = response
+    end
+  end
+
+  class ClientError   < Error; end
+  class NotFoundError < Error; end
+  class ServerError   < Error; end
+  class UnknownError  < Error; end
+end

data/lib/amara/path.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+module Amara
+  class Path < API
+    def base_path
+      path = self.current_options[:path]
+      if path.kind_of? Array
+        path.join('/')
+      else
+        path
+      end
+    end
+  end
+end

data/lib/amara/response.rb

@@ -17,26 +17,16 @@ module Amara
     def initialize(response, request={})
       @raw     = response
       @request = request
-
-      check_for_error(response)
-    end
-
-    def check_for_error(response)
-      status_code_type = response.status.to_s[0]
-      case status_code_type
-      when "2"
-        # puts "all is well, status: #{response.status}"
-      when "4", "5"
-        raise "Whoops, error back from Amara: #{response.status}"
-      else
-        raise "Unrecongized status code: #{response.status}"
-      end
     end
 
     def body
       self.raw.body
     end
 
+    def status
+      self.raw.status
+    end
+
     def object
       body.objects.nil? ? body : body.objects
     end
@@ -109,6 +99,5 @@ module Amara
       self.raw = new_response.raw
       self
     end
-
   end
 end

data/lib/amara/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module Amara
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/test/api_test.rb

@@ -46,7 +46,7 @@ describe Amara::API do
     response.limit.must_equal 2
     response.size.must_equal 2
     response.first.id.must_equal 1
-    
+
     second_response = '{"meta": {"limit": 2, "next": "/api2/partners/api/?limit=2&offset=4", "offset": 2, "previous":"/api2/partners/api/?limit=2&offset=0", "total_count": 5}, "objects": [{"id": 3}, {"id": 4}]}'
     stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=2').
        to_return(body: second_response)
@@ -70,4 +70,49 @@ describe Amara::API do
     response.wont_be :has_next_page?
   end
 
+  it "will raise errors" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(status: 500, body: '{}')
+
+    api = Amara::API.new(raise_errors: true)
+
+    error = proc {
+      response = api.list(limit: 2)
+    }.must_raise Amara::ServerError
+
+    error.response.wont_be_nil
+    error.response.status.must_equal 500
+    error.message.must_equal 'Whoops, error back from Amara: 500'
+  end
+
+  it "can return errors instead of raise them" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(status: 500, body: '{}')
+
+    api = Amara::API.new(raise_errors: false)
+    response = api.list(limit: 2)
+    response.status.must_equal 500
+
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(status: 500, body: '{}')
+
+    api = Amara::API.new(raise_errors: true)
+    response = api.list(limit: 2, options: { raise_errors: false } )
+    response.status.must_equal 500
+  end
+
+  it "can use bang methods to raise errors" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(status: 500, body: '{}')
+
+    api = Amara::API.new(raise_errors: false)
+
+    error = proc {
+      response = api.list!(limit: 2)
+    }.must_raise Amara::ServerError
+
+    error.response.wont_be_nil
+    error.response.status.must_equal 500
+    error.message.must_equal 'Whoops, error back from Amara: 500'
+  end
 end

data/test/client_test.rb

@@ -19,4 +19,58 @@ describe Amara::Client do
     amara.languages.wont_be_nil
   end
 
+  it "returns a path api object" do
+    amara = Amara::Client.new
+    amara.path('some/path').wont_be_nil
+  end
+
+  it "throws no error on 200" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(body: nil, status: 200)
+    begin
+      Amara::API.new.list(limit: 2)
+    rescue
+      flunk "Client error should not be thrown!"
+    end
+  end
+
+  it "throws a client error on 400s (except 404)" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(body: nil, status: 400)
+    error = proc {
+      Amara::API.new.list(limit: 2)
+    }.must_raise Amara::ClientError
+
+    error.response.status.must_equal 400
+  end
+
+  it "throws a not found error on 404" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(body: nil, status: 404)
+    error = proc {
+      Amara::API.new.list(limit: 2)
+    }.must_raise Amara::NotFoundError
+
+    error.response.status.must_equal 404
+  end
+
+  it "throws a server error on 500s" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(body: nil, status: 500)
+    error = proc {
+      Amara::API.new.list(limit: 2)
+    }.must_raise Amara::ServerError
+
+    error.response.status.must_equal 500
+  end
+
+  it "throws an unknown error on all other errors" do
+    stub_request(:get, 'https://www.amara.org/api2/partners/api/?limit=2&offset=0').
+       to_return(body: nil, status: 601)
+    error = proc {
+      Amara::API.new.list(limit: 2)
+    }.must_raise Amara::UnknownError
+
+    error.response.status.must_equal 601
+  end
 end

data/test/path_test.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+describe Amara::Path do
+
+  it "returns a path api object" do
+    amara = Amara::Client.new
+    assert_equal amara.path('some/path').class, Amara::Path
+  end
+
+  it "raises an exception if no path is passed" do
+    amara = Amara::Client.new
+    assert_raises ArgumentError do
+      amara.path.wont_be_nil
+    end
+  end
+
+  it "sets the custom path" do
+    amara = Amara::Client.new
+    path = amara.path('some/path')
+    assert_equal 'some/path', path.current_options['path']
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amara
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -172,8 +172,10 @@ files:
 - lib/amara/client.rb
 - lib/amara/configuration.rb
 - lib/amara/connection.rb
+- lib/amara/errors.rb
 - lib/amara/languages.rb
 - lib/amara/message.rb
+- lib/amara/path.rb
 - lib/amara/response.rb
 - lib/amara/teams.rb
 - lib/amara/teams/applications.rb
@@ -189,6 +191,7 @@ files:
 - lib/amara/videos/urls.rb
 - test/api_test.rb
 - test/client_test.rb
+- test/path_test.rb
 - test/teams/projects_test.rb
 - test/teams_test.rb
 - test/test_helper.rb
@@ -219,6 +222,7 @@ summary: Works with API v1.2, http://amara.readthedocs.org/en/latest/api.html
 test_files:
 - test/api_test.rb
 - test/client_test.rb
+- test/path_test.rb
 - test/teams/projects_test.rb
 - test/teams_test.rb
 - test/test_helper.rb