adtraction-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44351005560cd321ae257c4c827faede38685b4edc723a4a0d30f9389f478012
-  data.tar.gz: 194329ea1b9319cd3bdeeff05548cf8a0211b0bd142d40e3773aeea91c9c6c75
+  metadata.gz: ccdc5f5c644b82a99b16cb8274474b49e46a4d8c608e6ab7fb96366336d74509
+  data.tar.gz: a69e42f6d2652d002f3947ef8649174d501d2b4f9a3f65f67718a15927de1475
 SHA512:
-  metadata.gz: 8a9e416e3af3dd4252732943ca676709d61f44f6bf42a92364363054c4a9f263c63b8928bb2086841da46dd640ce032675891fdff256549c46455696b77895d7
-  data.tar.gz: 33b0178996f9a83a3a39c20679a829a69b81bb42fb931205096f4f0d2e7ef1ef49627de2147656acb2585960a8149316033842c0645e00e5b79e2f42152e1aa1
+  metadata.gz: 3c996e20165389fe5070efd55b61dafdd91eaf9d6df90613bf03b3acf6ebf2c034879b35e8743a8d90454c5db2728d9a1d28a8e52fa9759adc406e4d8ad56295
+  data.tar.gz: ab3a9e8cb4372c0eb3176ec8f21e573f62c5eafd3d038fcbd968c1944516a58f77b9c992e0df23ec6f3f17682807678957aedc795e1a5b2d2997843805b8b6d2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adtraction-api (0.1.0)
+    adtraction-api (0.1.2)
       faraday (>= 0.15.4)
       faraday_middleware (>= 0.13.1)
       virtus (>= 1.0.5)

data/README.md

@@ -1,6 +1,6 @@
-# Adtraction::API
+# Adtraction::Api
 
-Adtraction::API is a Ruby client to interact with [Adtraction's](https://adtraction.com) [API](https://adtraction.docs.apiary.io/#).
+Adtraction::Api is a Ruby client to interact with [Adtraction's](https://adtraction.com) [API](https://adtraction.docs.apiary.io/#).
 
 ## Installation
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 First of all you need an Adtraction account in order to get your API key. After you've gotten ahold of your API key, configure the client to use it:
 
 ```ruby
-Adtraction::API.configure do |config|
+Adtraction::Api.configure do |config|
   config.api_key    =   "YOUR_API_KEY"
 end
 ```
@@ -37,7 +37,14 @@ rails g adtraction:api:install Adtraction
 If you're trying to access the API using multiple API keys, then initialize each client with its own separate config:
 
 ```ruby
-Adtraction::API::Client.new(configuration: Adtraction::API::Configuration.new(api_key: "SOME_OTHER_API_KEY"))
+Adtraction::Api::Client.new(configuration: Adtraction::Api::Configuration.new(api_key: "SOME_OTHER_API_KEY"))
+```
+
+To instantiate a client, simply:
+
+```ruby
+client = Adtraction::Api::Client.new
+client.approved_channels
 ```
 
 This project is a WIP and not all endpoints have been implemented. They'll be gradually implemented depending on what I personally need to use from the API.
@@ -64,4 +71,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Adtraction::API project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/adtraction-api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Adtraction::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/adtraction-api/blob/master/CODE_OF_CONDUCT.md).

data/adtraction-api.gemspec

@@ -5,7 +5,7 @@ require "adtraction/api/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "adtraction-api"
-  spec.version       = Adtraction::API::VERSION
+  spec.version       = Adtraction::Api::VERSION
   spec.authors       = ["Sebastian Johnsson"]
   spec.email         = ["sebastian.johnsson@gmail.com"]
 

data/bin/console

@@ -9,11 +9,11 @@ cfg_path              =   File.join(File.dirname(__FILE__), "../credentials.yml"
 if ::File.exists?(cfg_path)
   cfg                 =   YAML.load_file(cfg_path)
 
-  Adtraction::API.configure do |config|
+  Adtraction::Api.configure do |config|
     config.api_key    =   cfg["api_key"]
   
     config.faraday    =   {
-      user_agent: "Adtraction Ruby Client #{::Adtraction::API::VERSION}",
+      user_agent: "Adtraction Ruby Client #{::Adtraction::Api::VERSION}",
       verbose:    true
     }
   end

data/lib/adtraction/api.rb

@@ -19,18 +19,18 @@ if !String.instance_methods(false).include?(:camelize)
 end
 
 module Adtraction
-  module API
+  module Api
     
     class << self
       attr_writer :configuration
     end
   
     def self.configuration
-      @configuration ||= ::Adtraction::API::Configuration.new
+      @configuration ||= ::Adtraction::Api::Configuration.new
     end
 
     def self.reset
-      @configuration = ::Adtraction::API::Configuration.new
+      @configuration = ::Adtraction::Api::Configuration.new
     end
 
     def self.configure

data/lib/adtraction/api/affiliate/channels.rb

@@ -1,10 +1,10 @@
 module Adtraction
-  module API
+  module Api
     module Affiliate
       module Channels
         
         def approved_channels(path: "/affiliate/approvedchannels", options: {})
-          ::Adtraction::API::Models::Channel.parse(get(path, options: options)&.body)
+          ::Adtraction::Api::Models::Channel.parse(get(path, options: options)&.body)
         end
       
       end

data/lib/adtraction/api/affiliate/programs.rb

@@ -1,5 +1,5 @@
 module Adtraction
-  module API
+  module Api
     module Affiliate
       module Programs
         
@@ -12,7 +12,7 @@ module Adtraction
             data[param.to_s.camelize(:lower)] = value unless value.nil?
           end
           
-          ::Adtraction::API::Models::Program.parse(post(path, data: data, options: options)&.body)
+          ::Adtraction::Api::Models::Program.parse(post(path, data: data, options: options)&.body)
         end
         
         def program_info(program_id, path: "/affiliate/programinfo", options: {})

data/lib/adtraction/api/client.rb

@@ -1,15 +1,15 @@
 module Adtraction
-  module API
+  module Api
     class Client
       attr_accessor :configuration
     
-      def initialize(configuration: ::Adtraction::API.configuration)
+      def initialize(configuration: ::Adtraction::Api.configuration)
         self.configuration    =   configuration        
         raise InvalidApiKeyError, "You need to supply a valid API key!" if self.configuration.api_key.to_s.empty?
       end
       
-      include Adtraction::API::Affiliate::Channels
-      include Adtraction::API::Affiliate::Programs
+      include Adtraction::Api::Affiliate::Channels
+      include Adtraction::Api::Affiliate::Programs
     
       def to_uri(path)
         path                  =   path.gsub(/^\//i, "")
@@ -35,7 +35,7 @@ module Adtraction
       def request(path, method: :get, params: {}, data: {}, headers: {}, options: {})
         headers               =   {
           "X-Token"       =>  self.configuration.api_key,
-          "User-Agent"    =>  self.configuration.faraday.fetch(:user_agent, "Adtraction Ruby Client #{::Adtraction::API::VERSION}"),
+          "User-Agent"    =>  self.configuration.faraday.fetch(:user_agent, "Adtraction Ruby Client #{::Adtraction::Api::VERSION}"),
           "Content-Type"  =>  "application/json"
         }.merge(headers)
         
@@ -68,7 +68,7 @@ module Adtraction
       end
       
       def log(message)
-        puts "[Adtraction::API::Client] - #{Time.now}: #{message}" if !message.to_s.empty? && self.verbose
+        puts "[Adtraction::Api::Client] - #{Time.now}: #{message}" if !message.to_s.empty? && self.verbose
       end
     
     end

data/lib/adtraction/api/configuration.rb

@@ -1,5 +1,5 @@
 module Adtraction
-  module API
+  module Api
     class Configuration
       attr_accessor :host, :api_version, :api_key, :faraday
     
@@ -10,7 +10,7 @@ module Adtraction
       
         self.faraday          =   {
           adapter:    :net_http,
-          user_agent: "Adtraction Ruby Client #{::Adtraction::API::VERSION}",
+          user_agent: "Adtraction Ruby Client #{::Adtraction::Api::VERSION}",
           verbose:    false
         }
       end

data/lib/adtraction/api/constants.rb

@@ -1,5 +1,5 @@
 module Adtraction
-  module API
+  module Api
     module Constants
       
       TRANSACTION_TYPE_ENUM = {

data/lib/adtraction/api/models/channel.rb

@@ -1,5 +1,5 @@
 module Adtraction
-  module API
+  module Api
     module Models
       
       class Channel

data/lib/adtraction/api/models/program.rb

@@ -1,5 +1,5 @@
 module Adtraction
-  module API
+  module Api
     module Models
       
       class Program
@@ -59,15 +59,15 @@ module Adtraction
               program.send("#{column}=", item.fetch(api_column, nil))
             end
             
-            program.approval_status     =   Adtraction::API::Constants::APPROVAL_STATUS_ENUM.fetch(item.fetch("approvalStatus"))
-            program.email_marketing     =   Adtraction::API::Constants::EMAIL_MARKETING_ENUM.fetch(item.fetch("emailMarketing"))
-            program.sem_marketing       =   Adtraction::API::Constants::SEM_MARKETING_ENUM.fetch(item.fetch("semMarketing"))
-            program.social_marketing    =   Adtraction::API::Constants::SOCIAL_MARKETING_ENUM.fetch(item.fetch("socialMarketing"))
-            program.cashback_marketing  =   Adtraction::API::Constants::CASHBACK_MARKETING_ENUM.fetch(item.fetch("cashbackMarketing"))
-            program.coupon_marketing    =   Adtraction::API::Constants::COUPON_MARKETING_ENUM.fetch(item.fetch("couponMarketing"))
+            program.approval_status     =   Adtraction::Api::Constants::APPROVAL_STATUS_ENUM.fetch(item.fetch("approvalStatus"))
+            program.email_marketing     =   Adtraction::Api::Constants::EMAIL_MARKETING_ENUM.fetch(item.fetch("emailMarketing"))
+            program.sem_marketing       =   Adtraction::Api::Constants::SEM_MARKETING_ENUM.fetch(item.fetch("semMarketing"))
+            program.social_marketing    =   Adtraction::Api::Constants::SOCIAL_MARKETING_ENUM.fetch(item.fetch("socialMarketing"))
+            program.cashback_marketing  =   Adtraction::Api::Constants::CASHBACK_MARKETING_ENUM.fetch(item.fetch("cashbackMarketing"))
+            program.coupon_marketing    =   Adtraction::Api::Constants::COUPON_MARKETING_ENUM.fetch(item.fetch("couponMarketing"))
             
             program.compensations&.each do |compensation|
-              enum                      =   Adtraction::API::Constants::TRANSACTION_TYPE_ENUM.fetch(compensation["transactionType"], nil)
+              enum                      =   Adtraction::Api::Constants::TRANSACTION_TYPE_ENUM.fetch(compensation["transactionType"], nil)
               compensation["transactionType"]   =   enum unless enum.nil?
             end
             

data/lib/adtraction/api/version.rb

@@ -1,5 +1,5 @@
 module Adtraction
-  module API
-    VERSION = "0.1.1"
+  module Api
+    VERSION = "0.1.2"
   end
 end

data/lib/generators/adtraction/api/install_generator.rb

@@ -3,14 +3,14 @@
 require "rails/generators/base"
 
 module Adtraction
-  module API
+  module Api
     module Generators
       class InstallGenerator < Rails::Generators::NamedBase
         include Rails::Generators::ResourceHelpers
         
         source_root File.expand_path('templates', __dir__)
 
-        desc "Creates an initializer for Adtraction::API for your Rails application."
+        desc "Creates an initializer for Adtraction::Api for your Rails application."
         
         def copy_initializer_file
           copy_file "config.rb", "config/initializers/adtraction_api.rb"

data/lib/generators/adtraction/api/templates/config.rb

@@ -1,3 +1,3 @@
-Adtraction::API.configure do |config|
+Adtraction::Api.configure do |config|
   config.api_key    =   "ENTER_YOUR_API_KEY_HERE"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adtraction-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sebastian Johnsson