oi-api-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ec2819523ef00444ce014ef43cc6d24f1f0fea5
+  data.tar.gz: ced108a991f7395a937252c34cd0edc1a3c6de16
+SHA512:
+  metadata.gz: 3bf83a170f596a3362128294bd45c7d80b82d85da6edbba9ec2641b51e4176fe8fa4a885678361f1f3e608badcf07b9244fda6ebb0cbf3c61057065228967388
+  data.tar.gz: 9101956f704cbb75962cffdac3b45b1a789b5d8552dceef494d60adf748c42488388d9283ee0f83f251bb48b6cab913a69b6f5264d0a1e3221fba59e3e715a99

data/.env.sample

@@ -0,0 +1,2 @@
+TEST_OI_USERNAME=example_user
+TEST_OI_PASSWORD=password

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg/*
+.env

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--order rand
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oi-api-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jrod
+
+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,35 @@
+[![Code Climate](https://codeclimate.com/github/jspillers/oi-api-ruby/badges/gpa.svg)](https://codeclimate.com/github/jspillers/oi-api-ruby)
+[![Test Coverage](https://codeclimate.com/github/jspillers/oi-api-ruby/badges/coverage.svg)](https://codeclimate.com/github/jspillers/oi-api-ruby)
+
+# OiApi Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oi-api-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oi-api-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Testing
+1. `cp .env.sample .env` and edit values accordingly

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+ 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+end

data/api_issues.md

@@ -0,0 +1,89 @@
+## Soft deleting advertisers?
+
+Creating an advertiser, then deleting it, then attempting to create another advertiser with the same name results in a validation error. I suspect that DELETEs via the API are soft deletes and then validation is being triggered by the soft deleted records. 
+
+This is a problem when trying to run automated tests against the API. Ideally, each individual test would involve a full setup and breakdown of test records. The problem described above forces the use of a long random string for the name field (to minimize chance of name reuse) and is undoubtedly creating a ton of records upstream.
+
+```
+  >> api.advertisers.size
+  => 0
+
+  >> api.create_advertiser('name': 'test advertiser', status_id: 1, category_id: 1010)
+  => {"status"=>"Create Successful", "message"=>"Advertiser successfully created", "id"=>39437}
+
+  >> api.advertisers.size
+  => 1
+
+  >> api.advertisers.first
+  => {"id"=>39437, "name"=>"test advertiser", "status_id"=>1, "category_id"=>1010, "key"=>"", "create_date"=>"2015-04-21T16:03:42", "modify_date"=>"2015-04-21T16:03:42"}
+
+  >> api.delete_advertiser(39437)
+  => {"status"=>"Delete Successful", "message"=>"Advertiser Succesfully deleted"}
+
+  >> api.advertisers.size
+  => 0
+
+  >> api.create_advertiser('name': 'test advertiser', status_id: 1, category_id: 1010)
+  => {"status"=>"Create Failed", "message"=>"Name exists"}
+```
+
+## Need test card numbers for proper testing of POST, PUT /advertisers/123/cards/
+
+## HTTP Status codes inconsistent when a resource doesn't exist
+
+When various operations are carried out on id's that do not exist, there are many inconsistencies in the various responses. All of the endpoints below should behave consistently when carrying out a request against a resource that does not exist:
+
+#### PUT /advertisers/9999999999999/ 
+
+Currently returns:
+  * HTTP status code: 400
+  * message: 'No permission to update advertiser'
+  * status: 'Update Failed'
+
+More appropriate and consistent would be:
+  * HTTP status code: 404
+  * message: 'Record not found'
+  * status: 'error'
+
+#### GET /advertisers/9999999999999/
+
+Currently returns:
+  * HTTP status code: 400
+  * message: 'No permission to view advertiser.' 
+  * status: 'Retrieve Failed'
+  
+More appropriate and consistent would be:
+  * HTTP status code: 404
+  * message: 'Record not found'
+  * status: 'error'
+
+#### DELETE /advertisers/9999999999999/
+
+Currently returns:
+  * HTTP status code: 403
+  * message: 'Operation not allowed' 
+  * status: 'Request Failed'
+  
+More appropriate and consistent would be:
+  * HTTP status code: 404
+  * message: 'Record not found'
+  * status: 'error'
+
+# DataTransfer messaging
+
+In some places "Data Transfer" is returned in messages, but in others "DataTransfer" is returned. This should probably be consistent.
+
+## Consider nesting and scoping offers under advertisers (ie: /advertisers/123/offers/)
+
+The API should return all offers when performing a GET to /offers/ but should return only offers for a given advertiser when scoped by advertiser_id (GET /advertisers/123/offers/).
+
+## Typo in successful Update for offers
+
+when POSTing to /offers/123/ the "status" param returned has a typo: "Request Succesful" should be "Request Successful"
+
+## Are DELETE requests not allowed for offers?
+
+## Data transfers POST params redundancy
+
+Data transfers endpoint example POST params has an offer_id in both the URI and in the POST body. If the offer_id is coming from a nested resource it should probably be omitted from the POST body.
+

data/lib/oi_api.rb

@@ -0,0 +1,12 @@
+require 'oi_api/configuration'
+require 'oi_api/client'
+
+module OiApi
+
+  extend Configuration
+
+  def self.new(options={})
+    Client.new(options)
+  end
+
+end

data/lib/oi_api/client.rb

@@ -0,0 +1,98 @@
+require 'httparty'
+require 'oi_api/lookup_tables'
+require 'oi_api/client/advertisers'
+require 'oi_api/client/cards'
+require 'oi_api/client/charges'
+require 'oi_api/client/subscriptions'
+require 'oi_api/client/balances'
+require 'oi_api/client/offers'
+require 'oi_api/client/data_transfers'
+require 'oi_api/client/auto_responders'
+require 'oi_api/client/reports'
+
+module OiApi
+
+  class Client
+
+    include HTTParty
+    include OiApi::LookupTables
+    include OiApi::Client::Advertisers
+    include OiApi::Client::Cards
+    include OiApi::Client::Charges
+    include OiApi::Client::Subscriptions
+    include OiApi::Client::Balances
+    include OiApi::Client::Offers
+    include OiApi::Client::DataTransfers
+    include OiApi::Client::AutoResponders
+    include OiApi::Client::Reports
+
+    # setup accessors on this client for all config keys
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to config module defaults
+      merged_options = OiApi.options.merge(options)
+
+      # Copy the merged values to this client and ignore those
+      # not part of our configuration
+      OiApi::Configuration::VALID_CONFIG_KEYS.each do |key|
+        public_send("#{key}=", merged_options[key])
+      end
+
+      # set base_uri and format via HTTParty class methods
+      self.class.base_uri(api_endpoint)
+      self.class.format(format)
+    end
+
+    def get(url, options = {})
+      self.class.get url, options_with_basic_auth(options)
+    end
+
+    def post(url, options = {})
+      self.class.post url, options_with_basic_auth(options)
+    end
+
+    def put(url, options = {})
+      self.class.put url, options_with_basic_auth(options)
+    end
+
+    def delete(url, options = {})
+      self.class.delete url, options_with_basic_auth(options)
+    end
+
+    private
+
+    def basic_auth_options
+      {
+        :username => username,
+        :password => password
+      }
+    end
+
+    def default_header_options
+      {
+        'Content-Type' => content_type,
+        'User-Agent' => user_agent
+      }
+    end
+
+    def options_with_basic_auth(options = {})
+      headers = options.has_key?(:headers) ? options.delete(:headers) : {}
+      query_string = options.has_key?(:query) ? options.delete(:query) : {}
+      body = options
+
+      _options = {
+        basic_auth: basic_auth_options,
+        headers: default_header_options.merge(headers),
+      }
+
+      _options[:debug_output] = debug_output if debug_output
+      _options[:body] = body.to_json unless body.empty?
+      _options[:query] = query_string unless query_string.empty?
+
+      _options
+    end
+
+  end
+
+end

data/lib/oi_api/client/advertisers.rb

@@ -0,0 +1,31 @@
+module OiApi
+
+  class Client
+
+    module Advertisers
+
+      def advertisers(options = {})
+        get '/advertisers/', options
+      end
+
+      def advertiser(advertiser_id, options = {})
+        get "/advertisers/#{advertiser_id}/", options
+      end
+
+      def create_advertiser(options = {})
+        post '/advertisers/', options
+      end
+
+      def update_advertiser(advertiser_id, options = {})
+        put "/advertisers/#{advertiser_id}/", options
+      end
+
+      def delete_advertiser(advertiser_id, options = {})
+        delete "/advertisers/#{advertiser_id}/", options
+      end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/auto_responders.rb

@@ -0,0 +1,35 @@
+module OiApi
+
+  class Client
+
+    module AutoResponders
+
+      def all_auto_responders(options = {})
+        get '/autoresponders/', options
+      end
+
+      def auto_responders(offer_id, options = {})
+        get "/offers/#{offer_id}/autoresponders/", options
+      end
+
+      def auto_responder(offer_id, auto_responder_id, options = {})
+        get "/offers/#{offer_id}/autoresponders/#{auto_responder_id}/", options
+      end
+
+      def create_auto_responder(offer_id, options = {})
+        post "/offers/#{offer_id}/autoresponders/", options
+      end
+
+      def update_auto_responder(offer_id, auto_responder_id, options = {})
+        put "/offers/#{offer_id}/autoresponders/#{auto_responder_id}/", options
+      end
+
+      #def delete_auto_responder(offer_id, auto_responder_id, options = {})
+      #  delete "/offers/#{offer_id}/autoresponders/#{auto_responder_id}/", options
+      #end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/balances.rb

@@ -0,0 +1,15 @@
+module OiApi
+
+  class Client
+
+    module Balances
+
+      def balance(advertiser_id, options = {})
+        get "/advertisers/#{advertiser_id}/balance/", options
+      end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/cards.rb

@@ -0,0 +1,33 @@
+module OiApi
+
+  class Client
+
+    module Cards
+
+      # no GET all?
+      #def cards(advertiser_id, options = {})
+      #  get "/advertisers/#{advertiser_id}/cards/", options
+      #end
+
+      def card(advertiser_id, card_id, options = {})
+        get "/advertisers/#{advertiser_id}/cards/#{card_id}/", options
+      end
+
+      def create_card(advertiser_id, options = {})
+        post "/advertisers/#{advertiser_id}/cards/", options
+      end
+
+      def update_card(advertiser_id, card_id, options = {})
+        put "/advertisers/#{advertiser_id}/cards/#{card_id}/", options
+      end
+
+      # no delete?
+      #def delete_card(advertiser_id, card_id, options = {})
+      #  delete "/advertisers/#{advertiser_id}/cards/#{card_id}/", options
+      #end
+
+    end
+
+  end
+
+end

data/lib/oi_api/client/charges.rb

@@ -0,0 +1,15 @@
+module OiApi
+
+  class Client
+
+    module Charges
+
+      def create_charge(advertiser_id, options = {})
+        post "/advertisers/#{advertiser_id}/charges/", options
+      end
+
+    end
+
+  end
+
+end