whatconverts 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a97a59bb1e26bf1762a4e35de2210d714e4843a3
+  data.tar.gz: 2e72e56d0557ba2e0bc9852a50331db15e59e8d8
+SHA512:
+  metadata.gz: d29baea75f5c055b1ce5dc583fde85ba67155bd3011322f3188b327d8f158563d2e3263ce7ecde37cbe22b21d4b9c8468e345efc765a1f76c214d7e5a3b191dd
+  data.tar.gz: fb937628f77d1b2532067584a6a23c9d3184eb12a5ce44ede85831f75b5d2cb7db969ee34c7f4fb7be101f158277fe71db3d8be6673fd5f6ffd92aec85a2a1bf

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+/examples/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Macbook Pro
+
+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,56 @@
+# The WhatConverts Ruby Gem
+
+A Ruby interface for the [WhatConverts API](https://whatconverts.com/api). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'whatconverts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whatconverts
+
+## Usage
+
+```ruby
+client = Whatconverts::Client.new do |config|
+  config.api_token = 'YOUR_API_TOKEN'
+  config.api_secret = 'TOUR_API_SECRET'
+end
+
+# retrieve leads
+client.leads
+
+# retrieve leads with param filtering
+client.leads(lead_type: 'phone_call', lead_status: 'unique')
+
+# fetch lead by ID
+client.lead(999)
+
+# create new lead
+client.create_lead(
+  lead_type: 'Web Form',
+  form_name: 'My Form'
+)
+
+# edit existing lead
+client.edit_lead(999, lead_source: 'google')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/neeaagh/whatconverts.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whatconverts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/whatconverts.rb

@@ -0,0 +1,9 @@
+require 'json'
+require 'faraday'
+
+require 'whatconverts/version'
+require 'whatconverts/client'
+require 'whatconverts/http_service'
+require 'whatconverts/error_checker'
+require 'whatconverts/errors'
+

data/lib/whatconverts/client.rb

@@ -0,0 +1,35 @@
+module Whatconverts
+  class Client
+
+    attr_accessor :api_token, :api_secret
+    
+    def initialize
+      yield self if block_given?
+    end
+
+    def leads(params = {})
+      http_service.make_request('leads', params)
+    end
+
+    def lead(lead_id, params = {})
+      http_service.make_request("leads/#{lead_id}", params)
+    end
+
+    def create_lead(params = {})
+      params.merge!(method: :post)
+      http_service.make_request('leads', params)
+    end
+
+    def edit_lead(lead_id, params = {})
+      params.merge!(method: :post)
+      http_service.make_request("leads/#{lead_id}", params)
+    end
+
+    private
+
+    def http_service
+      HttpService.new(api_token, api_secret)
+    end
+
+  end
+end

data/lib/whatconverts/error_checker.rb

@@ -0,0 +1,31 @@
+module Whatconverts
+  class ErrorChecker
+
+    attr_reader :api_response
+    
+    def initialize(api_response)
+      @api_response = api_response
+    end
+
+    def error_if_appropriate
+      return AuthError.new(response_body) if is_auth_error?
+      return ApiError.new(response_body) if is_error?
+    end
+
+    private
+
+    def is_auth_error?
+      api_response.status.to_i == 401
+    end
+
+    def is_error?
+      api_response.status.to_i >= 400
+    end
+
+    def response_body
+      JSON.parse(api_response.body)['error_message']
+    rescue
+      api_response.body
+    end
+  end
+end

data/lib/whatconverts/errors.rb

@@ -0,0 +1,4 @@
+module Whatconverts
+  class ApiError < StandardError; end
+  class AuthError < StandardError; end
+end

data/lib/whatconverts/http_service.rb

@@ -0,0 +1,27 @@
+module Whatconverts
+  class HttpService
+    API_URL = 'https://app.whatconverts.com/api/v1/'.freeze
+
+    attr_accessor :api_token, :api_secret
+
+    def initialize(api_token, api_secret)
+      @api_token = api_token
+      @api_secret = api_secret
+    end
+
+    def make_request(endpoint, params = {})
+      method = params.delete(:method) { :get }
+      response =  connection.send(method, endpoint, params)
+      error = ErrorChecker.new(response).error_if_appropriate
+      raise error if error
+      JSON.parse(response.body)
+    end
+
+    def connection
+      conn = Faraday.new(url: API_URL)
+      conn.basic_auth(api_token, api_secret)
+      conn
+    end
+
+  end
+end

data/lib/whatconverts/version.rb

@@ -0,0 +1,3 @@
+module Whatconverts
+  VERSION = "0.1.1"
+end

data/whatconverts.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whatconverts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whatconverts"
+  spec.version       = Whatconverts::VERSION
+  spec.authors       = ["Joe Giancaspro"]
+  spec.email         = ["neeaagh@gmail.com"]
+
+  spec.summary       = %q{A Ruby gem for interacting with the WhatConverts API.}
+  spec.description   = %q{A Ruby gem for interacting with the WhatConverts API.}
+  spec.homepage      = "https://github.com/neeaagh/whatconverts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~>3.5"
+  spec.add_development_dependency "pry", "~>0.10"
+  spec.add_development_dependency "webmock", "2.1"
+
+  spec.add_dependency "faraday", "~> 0.9"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: whatconverts
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joe Giancaspro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A Ruby gem for interacting with the WhatConverts API.
+email:
+- neeaagh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/whatconverts.rb
+- lib/whatconverts/client.rb
+- lib/whatconverts/error_checker.rb
+- lib/whatconverts/errors.rb
+- lib/whatconverts/http_service.rb
+- lib/whatconverts/version.rb
+- whatconverts.gemspec
+homepage: https://github.com/neeaagh/whatconverts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for interacting with the WhatConverts API.
+test_files: []