woodpecker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4acded5023888075c59e421ade26c58a571a042
+  data.tar.gz: b2ae88caadaa09cf6e424661582c7e2cd71eb8b6
+SHA512:
+  metadata.gz: 4cb437d016207040b2740c3f36674092e4cdf8e3ea8a0446bf4c857f0549cefbb4f78ae3b5765e17e7954d8c0582ee086c37fd1cc52473f3124b9e6bc171d340
+  data.tar.gz: 51bcf4dad947dd080459e43935c0b11a20c5e1c403b7043871bf4c02acee38f2c9cf3eda6d4c377e6858fa850a22534535377ce7916702a36e05c67808940562

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  AllowURI: true
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (2016-08-02)
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michał Zając
+
+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 @@
+# Woodpecker
+
+A simple API client for [Woodpecker](https://woodpecker.co/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'woodpecker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install woodpecker
+
+## Usage
+
+An API key must be configured for this gem to work. This can be done anywhere in your application as long as it's done before you make any API calls.
+
+```ruby
+Woodpecker.configure do |config|
+  config.api_key = "insert api key here" # This is required
+  config.dummy_password = "insert dummy password here" # This is optional.
+end
+```
+
+ * `config.api_key` - this is your API key and it's **required**, you can read about how to generate one [here](http://help.woodpecker.co/article/16-api-docs)
+ * config.dummy_password - this is **optional** since Woodpecker's API doesn't really care what's here. It's "X" by default.
+
+These keys are available during runtime as:
+
+```ruby
+Woodpecker.configuration.api_key
+Woodpecker.configuration.dummy_password
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Quintasan/woodpecker.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'woodpecker'
+
+# 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.
+
+require 'pry'
+Pry.start

data/bin/setup

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

data/lib/woodpecker.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'typhoeus'
+
+require 'woodpecker/version'
+
+require 'woodpecker/configuration'
+require 'woodpecker/errors/configuration'
+
+require 'woodpecker/utils/request'
+
+require 'woodpecker/campaign'
+require 'woodpecker/prospect'
+require 'woodpecker/errors/prospect'
+
+require 'pry'
+
+module Woodpecker
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.campaign_list
+    Woodpecker::Utils::Request.get('campaign_list').map { |campaign| Campaign.new(campaign) }
+  end
+
+  def self.add_prospects_campaign(campaign_id, params = {}, prospects)
+    payload = { campaign: { campaign_id: campaign_id },
+                update: 'true',
+                prospects: prospects }.to_json
+    Woodpecker::Utils::Request.post('add_prospects_campaign', params, payload)
+  end
+
+  def self.add_prospects_list(params = {}, prospects)
+    payload = { update: 'true', prospects: prospects }.to_json
+    Woodpecker::Utils::Request.post('add_prospects_list', params, payload)
+  end
+
+  def self.stop_followups(params = {}, prospect)
+    payload = { prospect: { email: prospect.email } }.to_json
+    Woodpecker::Utils::Request.post('stop_followups', params, payload)
+  end
+end

data/lib/woodpecker/campaign.rb

@@ -0,0 +1,14 @@
+module Woodpecker
+  class Campaign
+    attr_accessor :id, :name, :status, :from_name, :from_email, :created
+
+    def initialize(campaign)
+      @id = campaign[:id]
+      @name = campaign[:name]
+      @status = campaign[:status]
+      @from_name = campaign[:from_name]
+      @from_email = campaign[:from_email]
+      @created = DateTime.iso8601(campaign[:created])
+    end
+  end
+end

data/lib/woodpecker/configuration.rb

@@ -0,0 +1,22 @@
+module Woodpecker
+  class Configuration
+    # Woodpecker API uses HTTP Basic Authentication where the token is the
+    # username and password can be anything. Weird.
+    attr_writer :api_key, :dummy_password
+
+    def initialize
+      @api_key = nil
+      @dummy_password = nil
+    end
+
+    def api_key
+      raise Errors::Configuration, 'Woodpecker API key missing!' unless @api_key
+      @api_key
+    end
+
+    def dummy_password
+      raise Errors::Configuration, 'Dummy password is missing!' unless @dummy_password
+      @dummy_password
+    end
+  end
+end

data/lib/woodpecker/errors/configuration.rb

@@ -0,0 +1,6 @@
+module Woodpecker
+  module Errors
+    class Configuration < StandardError
+    end
+  end
+end

data/lib/woodpecker/errors/prospect.rb

@@ -0,0 +1,6 @@
+module Woodpecker
+  module Errors
+    class Prospect < StandardError
+    end
+  end
+end

data/lib/woodpecker/prospect.rb

@@ -0,0 +1,49 @@
+module Woodpecker
+  class Prospect
+    VALID_STATUSES = %w(active replied bounced autoreplied invalid blacklist).freeze
+    ATTRS = [:email, :status, :first_name, :last_name, :tags, :company,
+             :industry, :title, :phone, :address, :city, :state, :country, :website,
+             :snipet1, :snipet2, :snipet3, :snipet4].freeze
+
+    attr_accessor(*ATTRS)
+
+    def initialize(prospect)
+      @email = prospect[:email]
+      raise Errors::Prospect, "Invalid status, valid states are: #{VALID_STATUSES}." unless VALID_STATUSES.include?(prospect[:status])
+      @status = prospect[:status].upcase
+      @first_name = prospect[:first_name] || ''
+      @last_name = prospect[:last_name] || ''
+      @tags = prospect[:tags] || ''
+      @company = prospect[:company] || ''
+      @industry = prospect[:industry] || ''
+      @title = prospect[:title] || ''
+      @phone = prospect[:phone] || ''
+      @address = prospect[:address] || ''
+      @city = prospect[:city] || ''
+      @state = prospect[:state] || ''
+      @country = prospect[:country] || ''
+      @website = prospect[:website] || ''
+      @snipet1 = prospect[:snipet1] || ''
+      @snipet2 = prospect[:snipet2] || ''
+      @snipet3 = prospect[:snipet3] || ''
+      @snipet4 = prospect[:snipet4] || ''
+    end
+
+    def email
+      raise Errors::Prospect, 'Missing email' unless @email
+      @email
+    end
+
+    def to_h
+      hash = {}
+      ATTRS.each do |attr|
+        hash[attr.to_sym] = send(attr)
+      end
+      hash
+    end
+
+    def to_json(*_args)
+      to_h.to_json
+    end
+  end
+end

data/lib/woodpecker/utils/request.rb

@@ -0,0 +1,24 @@
+module Woodpecker
+  module Utils
+    module Request
+      module_function
+
+      def get(endpoint, params = {})
+        request = Typhoeus::Request.get("https://api.woodpecker.co/rest/v1/#{endpoint}",
+                                        userpwd: "#{Woodpecker.configuration.api_key}:#{Woodpecker.configuration.dummy_password}",
+                                        params: params)
+        data = JSON.parse(request.response_body, symbolize_names: true)
+        data
+      end
+
+      def post(endpoint, params = {}, body = {})
+        request = Typhoeus::Request.post("https://api.woodpecker.co/rest/v1/#{endpoint}",
+                                         userpwd: "#{Woodpecker.configuration.api_key}:#{Woodpecker.configuration.dummy_password}",
+                                         params: params,
+                                         body: body)
+        data = JSON.parse(request.response_body, symbolize_names: true)
+        data
+      end
+    end
+  end
+end

data/lib/woodpecker/version.rb

@@ -0,0 +1,25 @@
+module Woodpecker
+  module Version
+    module_function
+
+    def major
+      0
+    end
+
+    def minor
+      1
+    end
+
+    def patch
+      0
+    end
+
+    def to_a
+      [major, minor, patch].compact
+    end
+
+    def to_s
+      to_a.join('.')
+    end
+  end
+end

data/woodpecker.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'woodpecker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'woodpecker'
+  spec.version       = Woodpecker::Version
+  spec.authors       = ['Michał Zając']
+  spec.summary       = 'Simple Woodpecker API client'
+  spec.description   = 'Simple API client for Woodpecker. Woodpecker is a service to send personalized cold emails & follow-ups to your users. '
+  spec.homepage      = 'https://github.com/Quintasan/woodpecker'
+  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.add_dependency 'typhoeus', '~> 1.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1.11'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rubocop', '~> 0.42.0'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: woodpecker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Zając
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.11
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+description: 'Simple API client for Woodpecker. Woodpecker is a service to send personalized
+  cold emails & follow-ups to your users. '
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/woodpecker.rb
+- lib/woodpecker/campaign.rb
+- lib/woodpecker/configuration.rb
+- lib/woodpecker/errors/configuration.rb
+- lib/woodpecker/errors/prospect.rb
+- lib/woodpecker/prospect.rb
+- lib/woodpecker/utils/request.rb
+- lib/woodpecker/version.rb
+- woodpecker.gemspec
+homepage: https://github.com/Quintasan/woodpecker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple Woodpecker API client
+test_files: []