connect_wise_web_reports 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3383a03f7bf2501883d705393e127fd7cf59f913
+  data.tar.gz: dd234173f71a7e460c381dd0c3929e290bdfb88d
+SHA512:
+  metadata.gz: 43a75144611fb67d4dd06fccc829e3fa4bd3211cbd970d409b659340dba85afb69a3cf99a26d92de31094e97e2fe072928953fddbdd8a16d1c4ad9e47eec0b81
+  data.tar.gz: dbb9048e169ef304bc468a1262ed8c7ecdc48dc08f52b8907d349d2454b05a6c3662db7b9c7a9bfe65547008a56fe5299b76538aedbb2af2218730f60767078d

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+# ConnectWiseWebReports
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/connect_wise_web_reports`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'connect_wise_web_reports'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install connect_wise_web_reports
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/[USERNAME]/connect_wise_web_reports. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+# connect_wise_web_reports

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "connect_wise_web_reports"
+
+# 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/connect_wise_web_reports.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'connect_wise_web_reports/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'connect_wise_web_reports'
+  spec.version       = ConnectWiseWebReports::VERSION
+  spec.authors       = ['Kevin Pheasey']
+  spec.email         = ['kevin@kpheasey.com']
+
+  spec.summary       = %q{Connect Wise Web Reports API Wrapper}
+  spec.description   = %q{Full support Connect Wise Web Reports API, including custom queries, pagination, api info, and more.  }
+  spec.homepage      = 'https://github.com/kpheasey/connect_wise_web_reports'
+  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_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'mechanize', '~> 2.7', '>= 2.7.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.0'
+  spec.add_dependency 'plissken', '~> 0.2.0'
+end

data/lib/connect_wise_web_reports/configuration.rb

@@ -0,0 +1,29 @@
+module ConnectWiseWebReports
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :host, :company_id, :integrator_id, :integrator_password, :version,
+                  :proxy_host, :proxy_port, :proxy_user, :proxy_pass
+
+    def initialize
+      @version = 'v4_6_release'
+    end
+
+    def set(options = {})
+      options.each { |k, v| self.send("#{k.to_s}=", v) }
+    end
+
+  end
+
+end

data/lib/connect_wise_web_reports/report.rb

@@ -0,0 +1,111 @@
+module ConnectWiseWebReports
+
+  class Report
+
+    attr_accessor :options, :name, :records
+
+    def initialize(name, options = {})
+      @name = name
+      @options = ConnectWiseWebReports::DEFAULT_OPTIONS.merge(options)
+      @records = fetch
+    end
+
+    # @return [Array(Hash)]
+    def fetch
+      response = ConnectWiseWebReports.agent(options).get(url)
+      doc = Nokogiri::XML(response.content)
+
+      # raise errors if we got them
+      unless doc.xpath('//error/message').empty?
+        raise doc.xpath('//error/message').first.children.first.text
+      end
+
+      self.parse_records doc.xpath('//results/row')
+
+      return self.records
+    end
+
+    # Generate the Web Report request url.
+    #
+    # @return [String]
+    def url
+      url = "https://#{self.options[:host]}/#{self.options[:version]}/webreport/"
+
+      # Report
+      url += "?r=#{self.name}"
+
+      # API credentials
+      url += "&c=#{self.options[:company_id].to_s}"
+      url += "&u=#{self.options[:integrator_id].to_s}"
+      url += "&p=#{self.options[:integrator_password].to_s}"
+
+      #order
+      url += "&o=#{self.options[:order_by].to_s}" unless self.options[:order_by].nil?
+
+      # pagination
+      url += "&l=#{self.options[:limit].to_s}" unless self.options[:limit].nil?
+      url += "&s=#{self.options[:skip].to_s}" unless self.options[:skip].nil?
+
+      # timeout
+      url += "&t=#{self.options[:timeout].to_s}" unless self.options[:timeout].nil?
+
+      # fields
+      url += "&f=#{self.options[:fields].join('&f=')}" unless self.options[:fields].nil? || self.options[:fields].empty?
+
+      # conditions
+      url += "&q=#{self.options[:conditions]}" unless self.options[:conditions].blank?
+
+      return URI.escape(url)
+    end
+
+    def parse_records(rows)
+      self.records = []
+
+      rows.each do |row|
+        record = Hash.from_xml(row.to_s)['row'].to_snake_keys.with_indifferent_access
+        record.delete 'result_number'
+        self.records << record
+      end
+    end
+
+
+    ### Pagination ###
+
+    def page
+      if self.options[:limit].nil?
+        return 1
+      else
+        self.options[:skip] = 0 if self.options[:skip].nil?
+        return (self.options[:skip] / self.options[:limit]) + 1
+      end
+    end
+
+    def next_page?
+      if self.options[:limit].nil? || self.options[:limit].zero? || self.records.count < self.options[:limit]
+        return false
+      else
+        return true
+      end
+    end
+
+    def next_page
+      self.options[:skip] = 0 if self.options[:skip].nil?
+      self.options[:skip] += self.options[:limit]
+
+      return self.fetch
+    end
+
+    def previous_page?
+      self.page > 1
+    end
+
+    def previous_page
+      self.options[:skip] -= self.options[:limit]
+      self.options[:skip] = [0, self.options[:skip]].max # ensure we don't skip negative
+
+      return self.fetch
+    end
+
+  end
+
+end

data/lib/connect_wise_web_reports/version.rb

@@ -0,0 +1,3 @@
+module ConnectWiseWebReports
+  VERSION = '0.3.0'
+end

data/lib/connect_wise_web_reports.rb

@@ -0,0 +1,57 @@
+require 'mechanize'
+require 'nokogiri'
+require 'plissken'
+
+require 'connect_wise_web_reports/version'
+require 'connect_wise_web_reports/configuration'
+require 'connect_wise_web_reports/report'
+
+module ConnectWiseWebReports
+
+  DEFAULT_OPTIONS = {
+      conditions: nil,
+      fields: [],
+      limit: 100,
+      order_by: nil,
+      skip: nil,
+      timeout: 5,
+
+      # authentication
+      host: ConnectWiseWebReports.configuration.host,
+      company_id: ConnectWiseWebReports.configuration.company_id,
+      integrator_id: ConnectWiseWebReports.configuration.integrator_id,
+      integrator_password: ConnectWiseWebReports.configuration.integrator_password,
+      version: ConnectWiseWebReports.configuration.version,
+      proxy_host: ConnectWiseWebReports.configuration.proxy_host,
+      proxy_port: ConnectWiseWebReports.configuration.proxy_port,
+      proxy_user: ConnectWiseWebReports.configuration.proxy_user,
+      proxy_pass: ConnectWiseWebReports.configuration.proxy_pass
+  }
+
+  # Create a new Mechanize agent.
+  #
+  # @return [Mechanize]
+  def self.agent(options)
+    Mechanize.new do |agent|
+      agent.set_proxy(
+          options[:proxy_host],
+          options[:proxy_port],
+          options[:proxy_user],
+          options[:proxy_pass]
+      ) unless options[:proxy_host].nil?
+
+      agent.read_timeout = options[:timeout]
+      agent.keep_alive = false
+      agent.idle_timeout = 5
+    end
+  end
+
+  def self.info(options)
+    options = DEFAULT_OPTIONS.merge(options)
+    url = "https://#{options[:host]}/login/companyinfo/#{options[:company_id]}"
+    response = agent(options).get(url)
+
+    return JSON.parse(response.content)
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: connect_wise_web_reports
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kevin Pheasey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-19 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: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: plissken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 'Full support Connect Wise Web Reports API, including custom queries,
+  pagination, api info, and more.  '
+email:
+- kevin@kpheasey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- connect_wise_web_reports.gemspec
+- lib/connect_wise_web_reports.rb
+- lib/connect_wise_web_reports/configuration.rb
+- lib/connect_wise_web_reports/report.rb
+- lib/connect_wise_web_reports/version.rb
+homepage: https://github.com/kpheasey/connect_wise_web_reports
+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.0
+signing_key: 
+specification_version: 4
+summary: Connect Wise Web Reports API Wrapper
+test_files: []