synnex 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5dca190be2ccac057168d2415af830fdfcd05f375afd4f130729fa5ff314ec06
+  data.tar.gz: c91788d33598ee5b0d49d6248619c345ed54ca8734242e92f18928e84ac0c51e
+SHA512:
+  metadata.gz: 8cb60fd89ef27dbd2752fa7c34763c7d943446e2fa3c5a6ea45debf6e0243c61a991f693f1de91b27f24b0a45d42383a2be845aea33b179c458e9c14c179cb19
+  data.tar.gz: bc17f3e42ec59cf58d4f2e515e627a1fdb09ab3cae9958e47d2b881a6fb9b8d2bfe630fc911f025430ce672e482e4751aa3fdf95ff4d4393f648106e8c7f3aba

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.1

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 andygauge@gmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in synnex-gem.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Andrew Gauger
+
+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,37 @@
+# Synnex::Gem
+
+Use this gem to interact with Synnex API to query against office 365
+CSP.  It is possible to get customers, purchase subscriptions, and manage
+seats
+
+### To connect to the API, start with the Synnex::Msp object
+
+`msp = Synnex::Msp.new(user_name: 'user', password: 'pass', reseller: 12345)`
+to use the production instance include `endpoint: "production"`
+
+### To get customers
+
+`msp.customers`
+
+### Synnex::Customer
+
+The customer object has the following attributes:
+ - snx_eu_no
+ - company_name
+ - address1
+ - address2
+ - city
+ - state
+ - zip_code
+ - country
+ - contact_name
+ - email
+ - phone
+ - tenant_id
+ 
+Customer can also perform the following operations:
+ - `create_order(line_items, reseller_po, end_user_po, email)`
+   - `line_items` follow the `{snx_sku_no: 12345, quantity: 1}` pattern
+   
+subscriptions for a customer can be queried and manipulated by calling 
+`.subscriptions` on the `Synnex::Customer` object 

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,15 @@
+require 'httparty'
+require 'synnex/synnex_customer'
+require 'synnex/synnex_subscription'
+require 'synnex/synnex_api'
+require 'synnex/synnex_msp'
+
+# Use msp = Synnex::Msp.new(user_name: 'user', password: 'pass', reseller: 12345)
+# msp.customers.first.subscriptions.first
+module Synnex
+  UAT = 'https://testws.synnex.com'
+  PROD = 'https://ws.synnex.com'
+  HEADERS = {
+      'Content-Type' => 'application/json'
+  }
+end

data/lib/synnex/synnex_api.rb

@@ -0,0 +1,105 @@
+module Synnex
+
+  class API
+
+    # Pass the parameters to Synnex::API.new(user_name: 'user', password: 'pass', reseller: 12345)
+    # Pass the parameter {endpoint: 'production'} for the production endpoint
+    def initialize(hash)
+      raise "user_name is required" unless hash[:user_name]
+      raise "password is required" unless hash[:password]
+      raise "reseller is required" unless hash[:reseller]
+      @user_name = hash[:user_name]
+      @password = hash[:password]
+      @reseller = hash[:reseller]
+      @endpoint = hash[:endpoint] == 'production' ? Synnex::PROD : Synnex::UAT
+      get_auth_token
+      @headers = {'Authorization' => "Bearer #{@access_token}"}.merge(Synnex::HEADERS)
+    end
+
+    def customers
+      @customers ||= HTTParty.post("#{@endpoint}/webservice/solutions/csp",
+                                   body: {action_name: 'get_eu_list'}.to_json,
+                                   headers: @headers)
+                         .parsed_response["items"]
+                         .select {|customers| customers['tenant_id']}
+    end
+
+    def customer_subscription(cust_no)
+      HTTParty.post("#{@endpoint}/webservice/solutions/csp",
+                    body: {
+                        action_name: 'get_subscriptions_by_eu_no',
+                        snx_eu_no: cust_no
+                    }.to_json,
+                    headers: @headers)
+          .parsed_response["items"]
+    end
+
+    def subscription(id)
+      HTTParty.post("#{@endpoint}/webservice/solutions/csp",
+                    body: {
+                        action_name: 'get_subscription_by_id',
+                        subscription_id: id
+                    }.to_json,
+                    headers: @headers)
+          .parsed_response["items"]
+    end
+
+    def create_new_order(cust_no, li, rs, eu, email)
+      body = {
+          action_name: 'create_new_order',
+          snx_eu_no: cust_no,
+          line_items: li,
+      }
+      body[:rs_po_no] = rs if rs
+      body[:eu_po_no] = eu if eu
+      body[:notify_email] = email if email
+      HTTParty.post("#{@endpoint}/webservice/solutions/csp",
+                    body: body.to_json,
+                    headers: @headers)
+          .parsed_response
+    end
+
+    def update_seat(subscription, quantity, email)
+      body = {
+          action_name: "update_seat",
+          subscription_id: subscription,
+          new_quantity: quantity
+      }
+      body[:notify_email] = email if email
+      p body.to_json
+      HTTParty.post("#{@endpoint}/webservice/solutions/csp",
+                    body: body.to_json,
+                    headers: @headers)
+          .parsed_response
+
+    end
+
+    def cancel_subscription(subscription, email)
+      body = {
+          action_name: "cancel",
+          subscription_id: subscription,
+      }
+      body[:notify_email] = email if email
+      HTTParty.post("#{@endpoint}/webservice/solutions/csp",
+                    body: body.to_json,
+                    headers: @headers)
+          .parsed_response
+    end
+
+
+
+    private
+
+    def get_auth_token
+      body = {
+          action_name: "create_access_token",
+          user_name: @user_name,
+          password: @password,
+          snx_reseller_no: @reseller
+      }.to_json
+      result = HTTParty.post("#{@endpoint}/webservice/auth/token", body: body, headers: Synnex::HEADERS)
+      @access_token = result.parsed_response['access_token']
+      raise "Invalid Credentials" unless @access_token
+    end
+  end
+end

data/lib/synnex/synnex_customer.rb

@@ -0,0 +1,47 @@
+module Synnex
+  class Customer
+    attr_reader :snx_eu_no, :company_name, :address1, :address2, :city, :state, :zip_code, :country, :contact_name, :email, :phone, :tenant_id, :msp
+    def initialize(json, msp)
+      @snx_eu_no = json["snx_eu_no"]
+      @company_name = json["company_name"]
+      @address1 = json["address1"]
+      @address2 = json["address2"]
+      @city = json["city"]
+      @state = json["state"]
+      @zip_code = json["zip_code"]
+      @country = json["country"]
+      @contact_name = json["contact_name"]
+      @email = json["email"]
+      @phone = json["phone"]
+      @tenant_id = json["tenant_id"]
+      @msp = msp
+    end
+
+    def subscriptions
+      @subscriptions ||= api.customer_subscription(@snx_eu_no)
+                             .map {|subscription| Synnex::Subscription.new(api.subscription(subscription["subscription_id"]), self)}
+    end
+
+    # line_items is an array (optional) of the following hash {snx_sku_no: 12345, quantity: 1}
+    # returns true for success
+    def create_order(line_items, rs_po=nil , eu_po=nil , email=nil)
+      case line_items
+      when Hash
+        raise "line_items must follow {snx_sku_no: 12345, quantity: 1} convention" unless (line_items[:snx_sku_no].to_i > 0 && line_items[:quantity].to_i > 0)
+        line_items = [line_items]
+      when Array
+        raise "line_items must follow [{snx_sku_no: 12345, quantity: 1}, ...] convention" unless (line_items[0][:snx_sku_no].to_i > 0 && line_items[0][:quantity].to_i > 0)
+      else
+        raise "line_items must be a hash or array of hashes"
+      end
+      response = api.create_new_order(snx_eu_no, line_items, rs_po, eu_po, email)
+      response["status"] == "success" ? true : response["message"]
+    end
+
+    private
+
+    def api
+      msp.api
+    end
+  end
+end

data/lib/synnex/synnex_msp.rb

@@ -0,0 +1,15 @@
+module Synnex
+  class Msp
+    attr_reader :api
+    # Pass the parameters to Synnex::Msp.new(user_name: 'user', password: 'pass', reseller: 12345)
+    # Pass the parameter {endpoint: 'production'} for the production endpoint
+    def initialize(hash)
+      @api = Synnex::API.new(hash)
+    end
+
+    def customers
+      api.customers.map {|json| Synnex::Customer.new(json, self)}
+    end
+
+  end
+end

data/lib/synnex/synnex_subscription.rb

@@ -0,0 +1,35 @@
+module Synnex
+  class Subscription
+    attr_reader :id, :service_name, :snx_sku_no, :quantity, :status, :po, :price, :msrp, :customer
+    def initialize(json, customer)
+      info = json["subscriptions_info"][0]
+      @id = info["subscription_id"]
+      @service_name = info["service_name"]
+      @snx_sku_no = info["snx_sku_no"]
+      @quantity = info["quantity"]
+      @status = info["status"]
+      @po = json["rs_po_no"]
+      @price = info["unit_price"]
+      @msrp = info["msrp"]
+      @customer = customer
+    end
+
+    def change_quantity(qty, email=nil)
+      raise "Quantity must be greater than 0" unless qty > 0
+      response = api.update_seat(id, qty, email)
+      response["status"] == "success" ? true : response["message"]
+    end
+
+    def cancel(email=nil)
+      response = api.cancel_subscription(id, email)
+      response["status"] == "success" ? true : response["message"]
+    end
+
+    private
+
+    def api
+      customer.msp.api
+    end
+
+  end
+end

data/synnex.gemspec

@@ -0,0 +1,26 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "synnex"
+  spec.version       = '0.1.4'
+  spec.authors       = ["Andrew Gauger"]
+  spec.email         = ["andygauge@gmail.com"]
+
+  spec.summary       = "API access to Synnex ECExpress Stellr Cloud"
+  spec.description   = "Wraps the API up in object for managing office 365 licenses through Partner CSP"
+  spec.homepage      = "http://www.yetanother.site"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/andygauge/synnex-gem"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.add_runtime_dependency "httparty"
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: synnex
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Andrew Gauger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wraps the API up in object for managing office 365 licenses through Partner
+  CSP
+email:
+- andygauge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/synnex.rb
+- lib/synnex/synnex_api.rb
+- lib/synnex/synnex_customer.rb
+- lib/synnex/synnex_msp.rb
+- lib/synnex/synnex_subscription.rb
+- synnex.gemspec
+homepage: http://www.yetanother.site
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://www.yetanother.site
+  source_code_uri: https://github.com/andygauge/synnex-gem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.0.pre1
+signing_key: 
+specification_version: 4
+summary: API access to Synnex ECExpress Stellr Cloud
+test_files: []