adtraction-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 791a80074ca0d07d36224a23f07d40ffe8a3cd97bcda28aab518402e0a2a6b04
-  data.tar.gz: 7a8f2a76b0aa1311495eff2d2eb315ff4e4f70e0e936b0a01fa6e98e21d34c48
+  metadata.gz: 44351005560cd321ae257c4c827faede38685b4edc723a4a0d30f9389f478012
+  data.tar.gz: 194329ea1b9319cd3bdeeff05548cf8a0211b0bd142d40e3773aeea91c9c6c75
 SHA512:
-  metadata.gz: 03602252b4366d99c6d7eb95d10cea8ff7faacc7b277d56c9238c2130b8d85a818a5e81eda5727b86a69e799b9ea4956ec4ebd0b38fbc8ce32b2c244cc285d3b
-  data.tar.gz: be7519431ca4d53331d3bae97aae027f0d238cd904037aa04e2eb4bffc655b2d82db8376e26e8ac446d8767ad980704ad9e6aae7535822453ef40659cfa3d2d3
+  metadata.gz: 8a9e416e3af3dd4252732943ca676709d61f44f6bf42a92364363054c4a9f263c63b8928bb2086841da46dd640ce032675891fdff256549c46455696b77895d7
+  data.tar.gz: 33b0178996f9a83a3a39c20679a829a69b81bb42fb931205096f4f0d2e7ef1ef49627de2147656acb2585960a8149316033842c0645e00e5b79e2f42152e1aa1

data/.gitignore

@@ -7,6 +7,8 @@
 /spec/reports/
 /tmp/
 
+/spec/tmp/
+
 # rspec failure tracking
 .rspec_status
 

data/Gemfile.lock

@@ -9,33 +9,81 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.3)
     coderay (1.1.2)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    crass (1.0.4)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
     equalizer (0.0.11)
+    erubi (1.8.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     hashdiff (0.3.8)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
     method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
     multipart-post (2.0.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rake (12.3.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -51,7 +99,10 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     safe_yaml (1.0.5)
+    thor (0.20.3)
     thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     vcr (4.0.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
@@ -69,6 +120,7 @@ PLATFORMS
 DEPENDENCIES
   adtraction-api!
   bundler (>= 1.17)
+  generator_spec (>= 0.9.4)
   pry (~> 0.12.2)
   rake (>= 10.0)
   rspec (>= 3.0)

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,17 +23,21 @@ 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
 ```
 
-If you're using Ruby on Rails, just put this in an initializer e.g. under config/initializers/adtraction_api.rb.
+If you're using Ruby on Rails, you can generate an initializer using:
+
+```ruby
+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"))
 ```
 
 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.
@@ -60,4 +64,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"]
 
@@ -44,5 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr",        ">= 4.0"
   spec.add_development_dependency "webmock",    ">= 3.5.1"
   
+  spec.add_development_dependency "generator_spec", ">= 0.9.4"
+  
   spec.add_development_dependency "pry",        "~> 0.12.2"
 end

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
         
@@ -9,10 +9,10 @@ module Adtraction
           
           possible_params.each do |param|
             value           =   eval("#{param}")
-            data[param.to_s.camelize(false)] = value unless value.nil?
+            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/extensions/string.rb

@@ -1,12 +1,17 @@
 class String
     
-  def camelize(uppercase_first_letter = true)
+  def camelize(first_letter = :upper)
     string = self
-    if uppercase_first_letter
+    
+    case first_letter
+    when :upper
       string = string.sub(/^[a-z\d]*/) { $&.capitalize }
-    else
+    when :lower
       string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+    else
+      raise ArgumentError, "Invalid option, use either :upper or :lower."
     end
+
     string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
   end
   

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.0"
+  module API
+    VERSION = "0.1.1"
   end
 end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Adtraction
+  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."
+        
+        def copy_initializer_file
+          copy_file "config.rb", "config/initializers/adtraction_api.rb"
+        end
+      
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+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.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sebastian Johnsson
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +180,8 @@ files:
 - lib/adtraction/api/models/channel.rb
 - lib/adtraction/api/models/program.rb
 - lib/adtraction/api/version.rb
+- lib/generators/adtraction/api/install_generator.rb
+- lib/generators/adtraction/api/templates/config.rb
 homepage: https://github.com/SebastianJ/adtraction-api
 licenses:
 - MIT