clxsms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35d718dbf274590f881828d08bc206bf9e7f3b53
+  data.tar.gz: 217ba2ad7c168efd3ad6c80cf45d464ab3d02a50
+SHA512:
+  metadata.gz: adf30b51f2e5fbb369781f87d181cf1b40039afd64d60ea30004f33f1e26287b4fbcb24aeafe803cc1b5feb925f6950c2e03a4e46a1337a89b33a4dd3586283b
+  data.tar.gz: 9bc94fe72624652fad06ddc4568dee2adef583d3d9351f55d53d2b2a23279f630a5b1d3a2ae397d3b81ce46549d5e940468e7bfa1612ffdcb7fad747284f51bf

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+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 clxsms.gemspec
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# Clxsms
+By [Standout](http://standout.se/).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clxsms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clxsms
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome. 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.
+

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 "clxsms"
+
+# 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/clxsms.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clxsms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clxsms"
+  spec.version       = Clxsms::VERSION
+  spec.authors       = ["Hüseyin Öztürk"]
+  spec.email         = ["support@standout.se"]
+
+  spec.summary       = "API wrapper for Clxnetworks's SMS service"
+  spec.description   = "API wrapper for Clxnetworks's SMS service"
+  spec.homepage      = "https://bitbucket.org/standoutab/clxsms"
+
+  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_dependency "rest-client", '~> 1.8'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/clxsms.rb

@@ -0,0 +1,23 @@
+require 'clxsms/error'
+require 'clxsms/configuration'
+require 'clxsms/api'
+require 'clxsms/client'
+require 'clxsms/version'
+require 'rest-client'
+
+module Clxsms
+  extend Configuration
+  # Alias
+  def self.client(options={})
+    Clxsms::Client.new(options)
+  end
+
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_private = false)
+    client.respond_to?(method, include_private) || super(method, include_private)
+  end
+end

data/lib/clxsms/api.rb

@@ -0,0 +1,18 @@
+require 'clxsms/connection'
+require 'clxsms/request'
+
+module Clxsms
+  class API
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = Clxsms.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/clxsms/client.rb

@@ -0,0 +1,7 @@
+module Clxsms
+  class Client < API
+    require 'clxsms/client/sendsms'
+
+    include Clxsms::Client::Sendsms
+  end
+end

data/lib/clxsms/client/sendsms.rb

@@ -0,0 +1,9 @@
+module Clxsms
+  class Client
+    module Sendsms
+      def send_sms(options={})
+        response = get('sendsms', options)
+      end
+    end
+  end
+end

data/lib/clxsms/configuration.rb

@@ -0,0 +1,72 @@
+require 'clxsms/connection'
+require 'clxsms/request'
+require 'clxsms/version'
+
+module Clxsms
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+        :username,
+        :password,
+        :ssl_enabled,
+        :user_agent,
+        :dlr_url,
+        :dlr_mask,
+        :from
+    ].freeze
+
+    SSL_ENABLED = false
+
+    DEFAULT_USERNAME = nil
+
+    DEFAULT_PASSWORD = nil
+
+    HTTPS_HOST = "https://sms1.clxnetworks.net:3801"
+
+    HTTP_HOST = "http://sms1.clxnetworks.net:3800"
+
+    DEFAULT_USER_AGENT = "Clxsms Ruby Client/#{Clxsms::VERSION}".freeze
+
+    DEFAULT_DLR_URL = "http://localhost/"
+    DEFAULT_DLR_MASK = 7
+
+    DEFAULT_FROM = "0"
+
+
+    attr_accessor *VALID_OPTIONS_KEYS
+    attr_reader :http_host, :https_host
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
+      options
+    end
+
+    def http_host
+      HTTP_HOST
+    end
+
+    def https_host
+      HTTPS_HOST
+    end
+
+    # Reset to defaults
+    def reset
+      self.username = DEFAULT_USERNAME
+      self.password = DEFAULT_PASSWORD
+      self.ssl_enabled = SSL_ENABLED
+      self.user_agent = DEFAULT_USER_AGENT
+      self.dlr_url = DEFAULT_DLR_URL
+      self.dlr_mask = DEFAULT_DLR_MASK
+      self.from = DEFAULT_FROM
+      self
+    end
+  end
+end

data/lib/clxsms/connection.rb

@@ -0,0 +1,41 @@
+require 'clxsms/connection'
+require 'clxsms/request'
+require 'rest-client'
+
+module Clxsms
+  module Connection
+    private
+
+    def connection(path, params={})
+      host = Clxsms.ssl_enabled == true ? Clxsms.https_host : Clxsms.http_host
+      params.merge!({ 'dlr-mask': Clxsms.dlr_mask, 'dlr-url': Clxsms.dlr_url }) if params[:delivery_report] == true
+      params.delete :delivery_report
+
+      resource = RestClient::Resource.new(
+        host,
+        :headers => {
+          :content_type => "text/plain",
+          :timeout => 5,
+          :open_timeout => 5,
+          :user_agent => Clxsms.user_agent,
+        }
+      )
+
+      resource[path].get(
+        params: params.merge(
+          {
+            username: Clxsms.username,
+            password: Clxsms.password,
+          }
+        )
+      ){ |response, request, result, &block|
+        case response.code
+        when 202
+          { success: true, message: response }
+        else
+          { success: false, message: response }
+        end
+      }
+    end
+  end
+end

data/lib/clxsms/error.rb

@@ -0,0 +1,2 @@
+module Clxsms
+end

data/lib/clxsms/request.rb

@@ -0,0 +1,10 @@
+require 'clxsms/connection'
+require 'clxsms/request'
+
+module Clxsms
+  module Request
+    def get(path, query={})
+      connection(path, query)
+    end
+  end
+end

data/lib/clxsms/version.rb

@@ -0,0 +1,3 @@
+module Clxsms
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: clxsms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hüseyin Öztürk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: API wrapper for Clxnetworks's SMS service
+email:
+- support@standout.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clxsms.gemspec
+- lib/clxsms.rb
+- lib/clxsms/api.rb
+- lib/clxsms/client.rb
+- lib/clxsms/client/sendsms.rb
+- lib/clxsms/configuration.rb
+- lib/clxsms/connection.rb
+- lib/clxsms/error.rb
+- lib/clxsms/request.rb
+- lib/clxsms/version.rb
+homepage: https://bitbucket.org/standoutab/clxsms
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: API wrapper for Clxnetworks's SMS service
+test_files: []