openfire-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e1d440cf8eda88d3d1d21000254f2903d619094
+  data.tar.gz: 383920fb5dddab5338b6016a33980fd6ea9adde6
+SHA512:
+  metadata.gz: 7ea8162d5423ee30a5e7b0d643ef0622d0cd0f9790403708b876fbae4bff7f0ab84a602297df67564c2be69ef6b2581cad57f3310f7e42e9ccb6b506031bf236
+  data.tar.gz: 2feb0baa96063f647730053ba545e749fc64c8e60a67ffbbce7e33eeb6d758c4ae35c65efd5ad46f71073391521c1e425dc82debee76db6542070a1bf8130055

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 openfire-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jan Schwenzien
+
+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,54 @@
+# Openfire Ruby Client
+
+This is a ruby client for the [REST API plugin](http://www.igniterealtime.org/projects/openfire/plugins/restapi/readme.html
+) for [Openfire](http://www.igniterealtime.org/projects/openfire/).
+
+It is based on [Her](https://github.com/remiprev/her), takes care of the rather unusual JSON/XML reponses of the plugin, and provides Her::Models for the resources.
+
+[![Build Status](https://travis-ci.org/GeneralScripting/openfire-ruby.svg)](https://travis-ci.org/GeneralScripting/openfire-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openfire-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openfire-ruby
+
+## Usage
+
+Create a client:
+
+    client = Openfire::Client.new('http://localhost:9090', 'secrettoken')
+
+Access the User service:
+
+    # find all the users
+    client.users.all.to_a
+    
+    # get a specific user
+    client.users.find('username')
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/GeneralScripting/openfire-ruby](https://github.com/GeneralScripting/openfire-ruby). 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.
+
+
+## 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,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 "openfire/ruby"
+
+# 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/lib/faraday/request/xml.rb

@@ -0,0 +1,20 @@
+module Faraday
+  class Request
+    class XML < Faraday::Middleware
+      dependency 'active_support/all'
+
+      def initialize(app, options={})
+        @app     = app
+        @options = options
+      end
+
+      def call(env)
+        if env[:method] == :post
+          env[:body] = env[:body].to_xml(:root => env[:body].delete(:root))
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/faraday_middleware/parse_openfire_json.rb

@@ -0,0 +1,29 @@
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  class ParseOpenfireJson < FaradayMiddleware::ResponseMiddleware
+
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
+
+    define_parser do |body|
+      unless body.strip.empty?
+        parsed = ::JSON.parse body
+        case parsed.keys.length
+        when 0
+          parsed = []
+        when 1
+          parsed = parsed.values.first
+        end
+
+        if parsed.is_a?(Hash)
+          { data: parsed.symbolize_keys }
+        else
+          { data: parsed }
+        end
+      end
+    end
+
+  end
+end

data/lib/faraday_middleware/parse_openfire_xml.rb

@@ -0,0 +1,27 @@
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  class ParseOpenfireXml < FaradayMiddleware::ResponseMiddleware
+
+    dependency 'multi_xml'
+
+    define_parser do |body|
+      parsed = ::MultiXml.parse(body)
+      root = parsed.keys.first
+      if parsed[root].nil?
+        parsed[root] = []
+      else
+        parsed[root] = parsed[root].values.first
+        if parsed.keys.length == 1
+          parsed[root.to_s.pluralize] = parsed.delete(root)
+        end
+      end
+      if root == "error"
+        { errors: [parsed["errors"]], data: {} }
+      else
+        { data: parsed.symbolize_keys }
+      end
+    end
+
+  end
+end

data/lib/openfire/client.rb

@@ -0,0 +1,34 @@
+module Openfire
+  class Client
+
+    attr_accessor :her_client
+
+    HER_CLIENT = Her::API.new
+
+    def initialize(url, token, options={})
+      url.gsub!(/\/$/,'')
+      url = "http://#{url}" unless url.match /^http/
+      url = "#{url}/plugins/restapi/v1/"
+      headers = {
+        'Authorization' => token,
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      }
+      HER_CLIENT.setup url: url, headers: headers do |c|
+        c.request :json
+        c.response :openfire_xml,  content_type: /\bxml$/
+        c.response :openfire_json, content_type: /\bjson$/
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+
+    def groups
+      @groups ||= Openfire::Ruby::Group
+    end
+
+    def users
+      @users ||= Openfire::Ruby::User
+    end
+
+  end
+end

data/lib/openfire/ruby.rb

@@ -0,0 +1,23 @@
+#require 'faraday'
+
+require 'her'
+require 'faraday_middleware'
+#require 'faraday/request/xml'
+require 'faraday_middleware/parse_openfire_xml'
+require 'faraday_middleware/parse_openfire_json'
+
+require "openfire/client"
+require "openfire/ruby/base"
+require "openfire/ruby/group"
+require "openfire/ruby/user"
+require "openfire/ruby/version"
+
+#Faraday::Request.register_middleware xml: lambda { Faraday::Request::XML }
+Faraday::Response.register_middleware openfire_xml: lambda { FaradayMiddleware::ParseOpenfireXml }
+Faraday::Response.register_middleware openfire_json: lambda { FaradayMiddleware::ParseOpenfireJson }
+
+module Openfire
+  module Ruby
+    # nop
+  end
+end

data/lib/openfire/ruby/base.rb

@@ -0,0 +1,11 @@
+module Openfire
+  module Ruby
+    class Base
+
+      include Her::Model
+      use_api Openfire::Client::HER_CLIENT
+      parse_root_in_json true
+
+    end
+  end
+end

data/lib/openfire/ruby/group.rb

@@ -0,0 +1,9 @@
+# This class should never be used directly in your code.
+# Create an instance of Openfire::Client first and then
+# use client.groups
+module Openfire
+  module Ruby
+    class Group < Base
+    end
+  end
+end

data/lib/openfire/ruby/user.rb

@@ -0,0 +1,9 @@
+# This class should never be used directly in your code.
+# Create an instance of Openfire::Client first and then
+# use client.users
+module Openfire
+  module Ruby
+    class User < Base
+    end
+  end
+end

data/lib/openfire/ruby/version.rb

@@ -0,0 +1,5 @@
+module Openfire
+  module Ruby
+    VERSION = "0.1.0"
+  end
+end

data/openfire-ruby.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openfire/ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openfire-ruby"
+  spec.version       = Openfire::Ruby::VERSION
+  spec.authors       = ["Jan Schwenzien"]
+  spec.email         = ["jan@general-scripting.com"]
+
+  spec.summary       = %q{Ruby client for the REST API plugin of Openfire.}
+  spec.description   = %q{Ruby client for the REST API plugin of Openfire.}
+  spec.homepage      = "https://github.com/GeneralScripting/openfire-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #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 { |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_development_dependency "rspec"
+
+  spec.add_dependency "her"
+  #spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "multi_xml"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: openfire-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Schwenzien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-06 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: rspec
+  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: her
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  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: Ruby client for the REST API plugin of Openfire.
+email:
+- jan@general-scripting.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/faraday/request/xml.rb
+- lib/faraday_middleware/parse_openfire_json.rb
+- lib/faraday_middleware/parse_openfire_xml.rb
+- lib/openfire/client.rb
+- lib/openfire/ruby.rb
+- lib/openfire/ruby/base.rb
+- lib/openfire/ruby/group.rb
+- lib/openfire/ruby/user.rb
+- lib/openfire/ruby/version.rb
+- openfire-ruby.gemspec
+homepage: https://github.com/GeneralScripting/openfire-ruby
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby client for the REST API plugin of Openfire.
+test_files: []