ubiquity-envoi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b69bfd8c091f309758a7006121731f6f788b744c483c22011e4cb6f7365fa905
+  data.tar.gz: bf67605647e800b49003ddfad65da89e869ccb5d3fdd7bac65d625b3ad3b9d2c
+SHA512:
+  metadata.gz: 7e4920ca9c11de1d71515f22b8816ec931b2c595f97dfd939c843c52a2682acf6e0e2a989f317475200ff086a53b25560cc1ec4485af11a6114258ddf5545502
+  data.tar.gz: a41f5f9f0e84f8d3c2797961ed33c8c3dbd9f117b689279facd5ea7a054b37753badd1042c57831a09299cbca2b1ea81fe95ee2ae3ec1c39e4fd62f334516b39

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+ubiquity-envoi

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.8.7-head

data/.travis.yml

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

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 john.whitson@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 [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,8 @@
+source 'https://rubygems.org'
+
+gem 'json', :platforms => :mri_18
+
+# git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ubiquity-envoi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 XPlatform Consulting
+
+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,43 @@
+# Ubiquity::Envoi
+
+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/ubiquity/envoi`. 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 'ubiquity-envoi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ubiquity-envoi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/XPlatform-Consulting/ubiquity-envoi. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ubiquity::Envoi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ubiquity-envoi/blob/master/CODE_OF_CONDUCT.md).

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,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ubiquity/envoi'
+require 'ubiquity/envoi/api/client'
+
+# 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/exe/ubiquity-envoi

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'ubiquity/envoi'
+require 'ubiquity/envoi/api/client'

data/lib/ubiquity/envoi.rb

@@ -0,0 +1,7 @@
+require 'ubiquity/envoi/version'
+
+module Ubiquity
+  module Envoi
+
+  end
+end

data/lib/ubiquity/envoi/api/client.rb

@@ -0,0 +1,291 @@
+require 'logger'
+
+require 'ubiquity/envoi/api/client/http_client'
+require 'ubiquity/envoi/api/client/requests'
+require 'ubiquity/envoi/api/client/paginator'
+
+module Ubiquity
+  module Envoi
+    module API
+      class Client
+
+        attr_accessor :http_client, :request, :response, :logger
+
+        def initialize(args = { })
+          @http_client = HTTPClient.new(args)
+          @logger = http_client.logger
+        end
+
+        def process_request(request, options = nil)
+          @paginator = nil
+          @response = nil
+          @request = request
+          logger.warn { "Request is Missing Required Arguments: #{request.missing_required_arguments.inspect}" } unless request.missing_required_arguments.empty?
+
+          if ([:all, 'all'].include?(request.arguments[:_page]))
+            request.arguments[:_page] = 1
+            include_remaining_pages = true
+          else
+            include_remaining_pages = false
+          end
+
+          request.client = self unless request.client
+          options ||= request.options
+
+          return (options.fetch(:return_request, true) ? request : nil) unless options.fetch(:execute_request, true)
+
+          #@response = http_client.call_method(request.http_method, { :path => request.path, :query => request.query, :body => request.body }, options)
+          @response = request.execute
+
+          if request.respond_to?(:success?) && !request.success?
+            raise "Request failed. #{request.response.code} #{response.body}"
+          end
+
+          if include_remaining_pages
+            return paginator.include_remaining_pages
+          end
+
+          @response
+        end
+
+        def paginator
+          @paginator ||= Paginator.new(self, { :logger => logger }) if @response
+        end
+
+        def process_request_using_class(request_class, args, options = { })
+          @response = nil
+          @request = request_class.new(args, options.merge(:client => self))
+          process_request(@request, options)
+        end
+
+        # Exposes HTTP Methods
+        # @example http(:get, '/')
+        def http(method, *args)
+          @request = nil
+          @response = http_client.send(method, *args)
+          @request = http_client.request
+          @response
+        end
+
+        # ############################################################################################################## #
+        # @!group API Endpoints
+
+        def content(args = { }, options = { })
+          http :get, 'content'
+        end
+
+        def content_create(args = { }, options = { })
+
+        end
+
+        def content_details(args = { }, options = { })
+          http :get, "content/#{args[:id]}"
+        end
+
+        def content_field_details(args = { }, options = { })
+          http :get, "content-field/#{args[:id]}"
+        end
+
+        def content_fieldset_details(args = { }, options = { })
+          http :get, "content-fieldset/#{args[:id]}"
+        end
+
+        def content_type_details(args = { }, options = { })
+          http :get, "content-type/#{args[:id]}"
+        end
+
+        def content_fieldsets(args = { }, options = { })
+          http :get, 'content-fieldset'
+        end
+
+        def content_types(args = { }, options = { })
+          http :get, 'content-type'
+        end
+        alias :content_types_get :content_types
+
+        def file_get(args = { }, options = { })
+          id = args[:id]
+
+          http(:get, "file/#{id}")
+        end
+
+        def media_file_create(args = { }, options = { })
+          # _request = Requests::BaseRequest.new(
+          #   args,
+          #   {
+          #       :http_path => 'media-files/media-file',
+          #       :http_method => :post,
+          #       :parameters => [
+          #         { :name => :name, :required => true },
+          #         { :name => :description },
+          #         { :name => :file },
+          #         { :name => :metadata },
+          #         # { :name => 'file[path]', :aliases => [ :path ], :required => true },
+          #         # { :name => 'file[mime]', :aliases => [ :mime, :mime_type ], :required => true },
+          #         # { :name => 'file[size]', :aliases => [ :size ], :required => true },
+          #         # { :name => 'file[width]', :aliases => [ :width ] }
+          #       ]
+          #   }.merge(options)
+          # )
+          # process_request(_request, options)
+          process_request_using_class(Requests::MediaFileCreate, args, options)
+        end
+
+        def media_file_add_file(args = { }, options = { })
+          process_request_using_class(Requests::MediaFileAddFile, args, options)
+        end
+        alias :media_file_file_add :media_file_add_file
+
+        def media_file_delete(args = { }, options = { })
+          id = args[:id]
+
+          http(:delete, "media-files/media-file/#{id}")
+        end
+
+        def media_file_get(args = { }, options = { })
+          id = args[:id] || args[:media_file_id]
+
+          http(:get, "media-files/media-file/#{id}")
+        end
+
+        def media_file_files_get(args = { }, options = { })
+          id = args[:id] || args[:media_file_id]
+
+          http(:get, "media-files/media-file/#{id}/files")
+        end
+
+        def media_file_secured_get(args = { }, options = { })
+          _request = Requests::BaseRequest.new(
+              args,
+              {
+                  :http_path => 'media-files/media-file/#{path_arguments[:media_file_id]}/secure',
+                  :http_method => :post,
+                  # :body => args,
+                  :parameters => [
+                      { :name => :media_file_id, :aliases => [ :id ], :send_in => :path },
+                      { :name => :email, :send_in => :body },
+                  ]
+              }
+          )
+          process_request(_request, options)
+        end
+
+
+        # Transcode a Media File
+        #
+        # @param [Hash] args
+        # @option args [String] :media_file_id
+        # @option args [String] :transcoder_id
+        # @option args [Hash] :transcoder_args
+        # @see http://envoi.io/api/documentation/media-files/media-files-transcode
+        def media_file_transcode(args = { }, options = { })
+          media_file_id = args[:media_file_id]
+          transcoder_id = args[:transcoder_id]
+          transcoder_args = args[:transcoder_args] || {}
+
+          http(:post, "media-files/media-file/#{media_file_id}/action/transcode/#{transcoder_id}", transcoder_args)
+        end
+
+        def media_file_transcode_parameters_get(args = { }, options = { })
+          media_file_id = args[:media_file_id]
+          transcoder_id = args[:transcoder_id]
+
+          http(:get, "media-files/media-file/#{media_file_id}/action/transcode/#{transcoder_id}")
+        end
+
+        def media_file_transcoders_get(args = { }, options = { })
+          media_file_id = args[:media_file_id] || args[:id]
+
+          http(:get, "media-files/media-file/#{media_file_id}/action/transcode")
+        end
+
+        def media_file_update(args = { }, options = { })
+          process_request_using_class(Requests::MediaFileUpdate, args, options)
+        end
+
+        def media_files_get(args = { }, options = { })
+          # http(:get, 'media-files/media-file?_perPage=200')
+
+          _request = Requests::BaseRequest.new(
+              args,
+              {
+                  :http_path => 'media-files/media-file',
+                  :parameters => [
+                      { :name => :_perPage, :default_value => '200' },
+                      { :name => :_page, :default_value => '1' }
+                  ]
+              }
+          )
+          process_request(_request, options)
+        end
+
+        def media_files_detailed_get(args = { }, options = { })
+          # http(:get, 'media-files/media-file-detailed?_perPage=200')
+
+          _request = Requests::BaseRequest.new(
+              args,
+              {
+                  :http_path => 'media-files/media-file-detailed',
+                  :parameters => [
+                      { :name => :_perPage, :aliases => [ :perPage ], :default_value => '200' },
+                      { :name => :_page, :alises => [ :page ], :default_value => '1' }
+                  ]
+              }
+          )
+          process_request(_request, options)
+        end
+
+        def project_get(args = { }, options = { })
+          _request = Requests::BaseRequest.new(
+            args,
+            {
+              :http_path => 'production/project/#{path_arguments[:project_id]}',
+              :parameters => [
+                { :name => :project_id, :aliases => [ :id ], :send_in => :path }
+              ]
+            }
+          )
+
+          process_request(_request, options)
+        end
+
+        def projects_get(args = { }, options = { })
+          _request = Requests::BaseRequest.new(
+            args,
+            {
+              :http_path => 'production/project',
+              :parameters => [
+
+              ]
+            }
+          )
+
+          process_request(_request, options)
+        end
+
+        def storages_get(args = { }, options = { })
+          http(:get, 'media-files/storage')
+        end
+
+        def user_create(args = { }, options = { })
+
+        end
+
+        def who
+          http :get, 'who'
+        end
+
+        # @!endgroup API Endpoints
+        # ############################################################################################################## #
+
+        # Client
+      end
+
+      # API
+    end
+
+    # Envoi
+  end
+
+  # Ubiquity
+end