carbon_pms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab132c8bdd45705a23f576dc2dad791b094dd4ab
+  data.tar.gz: 70e2cebc7ce69b4d9029b336c52406ec80ccd102
+SHA512:
+  metadata.gz: 8bffdd76d3b79508e3ac1bfa479442d052ce66b46d5ed9dfbaf3932c192430a0736780be0b0ec5fb96ca28b50a44f20bdf5ecbe8fc5dda917001fd193f39cc73
+  data.tar.gz: 94b6513f41533d0e888fdb61bac7a65fac1e999925966cdff6fdc0564b0343e18c362afd5a9ebbde2ad41ac6c1601e00743dea7026c68e3a5b2aafcddab064dc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Mason
+
+MIT License
+
+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 @@
+# CarbonPms
+
+If you're not using a CarbonPMS server, then you don't need this.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carbon_pms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carbon_pms
+
+## Usage
+
+    require 'carbon_pms'
+    
+    client = CarbonPms::Client.new('example.com', 'auth_token', API_VERSION)
+    client.create_app(name: 'foo', auth_key: '123123')
+    
+You can also initialize the client with a configuration block:
+
+    # config/initializers/carbon_pms.rb (for instance)
+    CarbonPms.configure do |config|
+      config.host = 'example.com'
+      config.auth_token = 'abcdef'
+      config.version = '42'
+    end
+    # elsewhere
+    client = CarbonPms.Client.new
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/carbon_pms.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carbon_pms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carbon_pms"
+  spec.version       = CarbonPms::VERSION
+  spec.authors       = ["Chris Mason"]
+  spec.email         = ["chris@chaione.com"]
+  spec.description   = %q{Ruby client to send push messages to a Carbon PMS server.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/chaione/carbon_pms"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'httparty', '~> 0.10'
+end

data/lib/carbon_pms/client.rb

@@ -0,0 +1,65 @@
+module CarbonPms
+  class Client
+    include HTTParty
+    format :json
+
+    def initialize(host=CarbonPms.host, auth_token=CarbonPms.auth_token, version=CarbonPms.version)
+      if host.downcase.start_with?('http://', 'https://')
+        self.class.base_uri "#{host}/api"
+      else
+        self.class.base_uri "https://#{host}/api"
+      end
+      self.class.headers('Authorization' => "token #{auth_token}") if auth_token
+      self.class.headers('Accept' => "application/vnd.carbon.pms.v#{version}") if version
+    end
+
+    # Creates either a GCM or APNS app to receive push messages. You must create an app
+    # before you can send push notifications.
+    #
+    # @param [Hash] options hash to construct an app.
+    #   Must include :name and (:certificate or :auth_key)
+    # @option options [String] :name A name for this app. The name must be unique within the environment and app type
+    # @option options [String] :environment can be one of the following:
+    #   * _production_
+    #   * _development_
+    #   * _sandbox_
+    #   Defaults to _development_
+    # @option options [String] :auth_key Setting this key will create a GCM app. Your Google API key goes here. This option is mutually exclusive with :certificate
+    # @option options [String] :certificate Setting this key will create an APNS app. Your certificate needs to be in _pem_ format. This option is mutually exclusive with :auth_key
+    # @option options [String] :password The password to decrypt the certificate if it was encrypted.
+    # @raise [ArgumentError] if anything is amiss
+    # @return [HTTParty::Response] The response from the server. The following properties may be interesting:
+    #   * *body* : the parsed response body
+    #   * *code* : the status code
+    #   * *message* : the status message
+    #   * *headers* : the response headers
+    def create_app(options={})
+      raise ArguementError, 'You must provide an app name' unless options[:name]
+      options[:environment] = 'development' unless %w{production sandbox}.include? options[:environment]
+      return post('/app/apns', body: options) if options.has_key? :certificate
+      return post('/app/gcm', body: options) if options.has_key? :auth_key
+      raise ArguementError, 'You must provide a :certificate or :auth_key'
+    end
+
+    # Sends a push notification to the APNS
+    #
+    # @param [Hash] options hash to construct an app
+    # @option options [String] :device_token the device token to receive this push notification
+    # @option options [String] :app the name of the app
+    # @option options [String] :environment the environment this app is running in _(production, development, sandbox)_
+    # @option options [String] :alert the message to send
+    # @option options [Hash] :data any custom attributes to send
+    # @option options [Integer] :badge sets the badge number to the specified number
+    # @option options [String] :sound play the specified sound when the notification is received.
+    # @option options [Integer] :content_available notify the device that new content is available
+    def apns_notificaton(options={})
+      return post '/push/apns', query: options
+    end
+
+    private
+
+    def post(path, options={})
+      self.class.post path, options
+    end
+  end
+end

data/lib/carbon_pms/version.rb

@@ -0,0 +1,3 @@
+module CarbonPms
+  VERSION = "0.0.1"
+end

data/lib/carbon_pms.rb

@@ -0,0 +1,24 @@
+require 'carbon_pms/version'
+require 'carbon_pms/client'
+
+module CarbonPms
+  class << self
+    attr_accessor :host, :auth_token, :version
+
+    # config/initializers/carbon_pms.rb (for instance)
+    #
+    # CarbonPms.configure do |config|
+    #   config.host = 'example.com'
+    #   config.auth_token = 'abcdef'
+    #   config.version = '42'
+    # end
+    #
+    # elsewhere
+    #
+    # client = CarbonPms::Client.new
+    def configure
+      yield self
+      true
+    end
+  end
+end

data/spec/carbon_pms/client_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe CarbonPms::Client do
+  context 'initialization' do
+    let(:host) { 'example.com' }
+    let(:auth_token) { nil }
+    let(:version) { nil }
+    let(:client) { CarbonPms::Client.new(host, auth_token, version) }
+
+    context 'defaults' do
+      it 'should default to ssl when given a hostname' do
+        client.class.base_uri.should == 'https://example.com/api'
+      end
+
+      it 'should not have the authorization header set' do
+        client.class.headers.should_not have_key('Authorization')
+      end
+
+      it 'should not have the version header set' do
+        client.class.headers.should_not have_key('Accept')
+      end
+    end
+
+    context 'custom' do
+      let(:host) { 'http://example.com:5000' }
+      let(:auth_token) { 'abcdef' }
+      let(:version) { 42 }
+
+      it 'should use http if explicitly defined' do
+        client.class.base_uri.should == 'http://example.com:5000/api'
+      end
+
+      it 'should set the authorization header if given an auth token' do
+        client.class.headers['Authorization'].should eq 'token abcdef'
+      end
+
+      it 'should set the version header if given a version' do
+        client.class.headers['Accept'].should eq 'application/vnd.carbon.pms.v42'
+      end
+    end
+  end
+end

data/spec/carbon_pms_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CarbonPms do
+  it 'should have a version number' do
+    CarbonPms::VERSION.should_not be_nil
+  end
+
+  it 'should be able to set its attributes via a configuration block' do
+    CarbonPms.configure do |config|
+      config.host = 'example.com'
+      config.auth_token = 'abcdef'
+      config.version = 42
+    end
+    CarbonPms.host.should == 'example.com'
+    CarbonPms.auth_token.should == 'abcdef'
+    CarbonPms.version.should == 42
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'httparty'
+require 'carbon_pms'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: carbon_pms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Ruby client to send push messages to a Carbon PMS server.
+email:
+- chris@chaione.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carbon_pms.gemspec
+- lib/carbon_pms.rb
+- lib/carbon_pms/client.rb
+- lib/carbon_pms/version.rb
+- spec/carbon_pms/client_spec.rb
+- spec/carbon_pms_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chaione/carbon_pms
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby client to send push messages to a Carbon PMS server.
+test_files:
+- spec/carbon_pms/client_spec.rb
+- spec/carbon_pms_spec.rb
+- spec/spec_helper.rb