unbounce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6e68db8658b1ee575f0f3d245aa237d2856d91c
+  data.tar.gz: aec876d9c49fb7f3bed9e1bc25fbf99082bb94ca
+SHA512:
+  metadata.gz: 4cbf7abb6a45d19ded5174daf6a9ca91e412fbd8c990ebe5f343a4331ec32c2e5d62cc6ab278096c8f94b39e226dc50d997a6f018a3076e2b5d6baa8fc477c09
+  data.tar.gz: 6d8739426262827ad3e278000bcbf9670f74065168af3122345194d96d97a73b012ee5d8a526e4f1c9d720755b53fc3f8fa65cc8cb1125efa4b435e8a91e56e9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+test.rb
+*.gem
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mhoskison@etnainteractive.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in unbounce.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Hoskison
+
+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,155 @@
+# unbounce
+
+Simple GEM to access the Unbounce API. (https://unbounce.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unbounce'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unbounce
+
+## Usage
+
+### Setting Connection
+
+###### Required value
+* key: Your Unbounce API key.
+###### Optional 
+* api_url: 
+    Defaults to https://api.unbounce.com
+* api_version: 
+    Defaults to 0.4
+
+```ruby
+opts = {key: "<Your unbounce API Key>"}
+testcon = Unbounce::Api.new(:key => opts[:key]) 
+```
+
+### Query Parameters
+
+###### sort_order 
+* asc - Default
+* desc
+###### count
+When true, don't return the response's collection attribute.
+###### from
+Limit results to those created after from. Example: 2014-12-31T00:00:00.000Z
+###### to
+Limit results to those created before to. Example: 2014-12-31T23:59:59.999Z
+###### offset
+Omit the first offset number of results. Example: 3
+###### limit
+Only return limit number of results. Example: 100, Default set to Maximum of 1000
+###### with_stats
+When true, include page stats for the collection. 
+###### role
+Restricts the scope of the returned pages. one of viewer, author
+###### include_sub_pages
+When true, include sub page form fields in the response
+
+### Get Accounts
+Retrieve the accounts collection.
+
+Supported Params: 
+* sort_order
+
+```ruby
+testcon.get_accounts 
+```
+
+### Get Pages
+###### All Pages
+Retrieve a list of all pages. 
+
+Supported Params: 
+* sort_order
+* count
+* from
+* to
+* offset
+* limit
+* with_stats
+* role
+
+```ruby
+testcon.get_pages() 
+```
+###### All Pages for specific account
+```ruby
+ opts = {account_id:  <account_id>}
+ testcon.get_pages(opts) 
+ ```
+###### Specific page
+```ruby
+opts = {page_id:  <page_id>}
+testcon.get_pages(opts) 
+```
+###### Page Form Fields
+Retrieve a full list of all form fields across all page variants of a specific page.
+
+Supported Params: 
+* sort_order
+* count
+* include_sub_pages
+
+```ruby
+opts = {page_id:  <page_id>, form_fields: true}
+testcon.get_pages(opts) 
+```
+
+### Get Leads
+###### All for page
+Retrieve a list of all leads for a given page.
+
+Supported Params: 
+* sort_order
+* count
+* from
+* to
+* offset
+* limit
+
+```ruby
+opts = {page_id:  <page_id>}
+testcon.get_leads(opts) 
+```
+###### Single Lead
+Retrieve a single lead.
+
+```ruby
+opts = {lead_id:  <lead_id>}
+testcon.get_leads(opts) 
+```
+
+
+## Version History
+# v0.1.0
+Initial work for retrieving accounts, pages, and leads.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/mhoskiso/unbounce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Unbounce project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mhoskiso/unbounce/blob/master/CODE_OF_CONDUCT.md).

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 "unbounce"
+
+# 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(__FILE__)

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/unbounce.rb

@@ -0,0 +1,105 @@
+require 'bundler/setup'
+require "unbounce/version"
+require 'json'
+require 'ostruct'
+require 'rest-client'
+require "base64"
+
+module Unbounce
+  class Api
+    
+    MAX_RESULT_LIMIT = '1000'
+
+    def initialize(opts = {})
+      api_version = opts[:api_version].nil? ? "application/vnd.unbounce.api.v0.4+json" : "application/vnd.unbounce.api.v#{opts[:api_version]}+json"
+      @headers = {Accept: api_version}
+      @url = opts[:api_url].nil? ? "https://api.unbounce.com" : opts[:api_url]
+      @auth = 'Basic ' + Base64.encode64(opts[:key]).chomp  
+      @account_id = opts[:account_id].to_s if opts[:account_id]  
+
+      #  -H "Accept: application/vnd.unbounce.api.v0.4+json"
+    end
+
+    def set_account_id(opts = {})
+      @account_id = opts[:account_id].to_s
+    end    
+
+    def parse_json(response)
+      body = JSON.parse(response.to_str) if response.code == 200
+      OpenStruct.new(code: response.code, body: body)
+    end
+
+    def set_params(opts = {})
+      params = {}
+      #Result params
+      params[:path] = opts[:path] if opts[:path]
+      params[:sort_order] = opts[:sort_order] if opts[:sort_order] && (opts[:sort_order] == "asc" || opts[:sort_order] == "desc") # asc, desc
+      params[:count] = true if opts[:count] # When true, don't return the response's collection attribute.
+      params[:include_sub_pages] = true if opts[:include_sub_pages] # When true, include sub page form fields in the response
+
+      #Page params      
+      params[:from] = opts[:from] if opts[:from] # Limit results to those created after from. Example: 2014-12-31T00:00:00.000Z
+      params[:to] = opts[:to] if opts[:to] # Limit results to those created before to. Example: 2014-12-31T23:59:59.999Z
+      params[:offset] = opts[:offset] if opts[:offset] # Omit the first offset number of results. Example: 3
+      params[:limit] =  (opts[:limit] != nil && opts[:limit].to_i < MAX_RESULT_LIMIT.to_i && opts[:limit].to_i > 0 ) ? opts[:limit] : MAX_RESULT_LIMIT  # Only return limit number of results. Example: 100
+      params[:with_stats] = opts[:with_stats] if opts[:with_stats] # When true, include page stats for the collection. 
+      params[:role] = opts[:role] if opts[:role] # Restricts the scope of the returned pages. one of viewer, author
+     
+      return params
+    end
+
+    def get_responses(opts = {})
+      params = set_params(opts)
+      response = parse_json(RestClient.get(@url+params[:path], params: params,Authorization: @auth, headers: @headers)).body
+                 
+      # response = (opts[:data]) ? response[opts[:data]] : response 
+      
+      return response
+    end
+
+# Account 
+    def get_accounts(opts = {})
+      opts[:path] = "/accounts"       
+
+      if opts[:account_id]
+        opts[:path] = opts[:path] + "/#{opts[:account_id]}/pages"
+      else
+        # opts[:data] = "accounts"
+      end
+
+      return get_responses(opts)  
+    end
+
+# Pages
+    def get_pages(opts = {})
+      opts[:path] = "/pages"       
+
+      if opts[:account_id]
+        opts[:path] = "/accounts/#{opts[:account_id]}/pages"
+      elsif opts[:page_id]
+        opts[:path] = opts[:path] + "/#{opts[:page_id]}"
+        opts[:path] = opts[:path] + "/form_fields" if opts[:form_fields] == true
+      else
+       # opts[:data] = "pages" 
+      end    
+
+      return get_responses(opts)  
+    end
+
+# Leads
+  def get_leads(opts = {})
+
+    if opts[:page_id]
+      opts[:path] = "/pages/#{opts[:page_id]}/leads"
+    #  opts[:data] = "leads"
+    elsif opts[:lead_id]
+      opts[:path] = "/leads/#{opts[:lead_id]}"
+    end   
+
+    return get_responses(opts)  
+  end
+
+
+
+  end
+end

data/lib/unbounce/version.rb

@@ -0,0 +1,3 @@
+module Unbounce
+  VERSION = "0.1.0"
+end

data/unbounce.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "unbounce/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "unbounce"
+  spec.version       = Unbounce::VERSION
+  spec.authors       = ["Michael Hoskison"]
+  spec.email         = ["mhoskison@etnainteractive.com"]
+
+  spec.summary       = %q{Used to access the Unbounce api}
+  spec.description   = %q{Unbounce API}
+  spec.homepage      = "https://github.com/mhoskiso/unbounce.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "rest-client", "~> 2.0.2"
+  spec.add_dependency "json", "~> 2.1.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: unbounce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Hoskison
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Unbounce API
+email:
+- mhoskison@etnainteractive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/unbounce.rb
+- lib/unbounce/version.rb
+- unbounce.gemspec
+homepage: https://github.com/mhoskiso/unbounce.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Used to access the Unbounce api
+test_files: []