sigfox_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d80aa4b3cdf5d24253abb9e68c6ce058496334f716d37caaaf5d8dc5ebf72c54
+  data.tar.gz: f07c05cd6820bf662992d76dc2edf5800370cc2ba372d3e3259509e69891bf5e
+SHA512:
+  metadata.gz: e4e1483ccf7349798b31622192d53000cd7d94e581da11747bacd6c81318174f25a87f4b60d5a22458784daa13d619c534b3f5bd2e3e51eafce2c057fedc095a
+  data.tar.gz: 978e794eda935659f83fe1ea2ec29e5c5ed8f39f0765a28af18cdbbf46bfe00324c2d1eb8d515045d6b9b400acf5c341103aad7b53d6947f742db6e8c9c39ff9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.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 stardustkids83@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sigfox_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    sigfox_api (0.1.0)
+      faraday (= 0.17.1)
+      faraday_middleware (= 0.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.17.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    multipart-post (2.1.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sigfox_api!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 nightswinger
+
+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 @@
+# SigfoxApi
+
+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/sigfox_api`. 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 'sigfox_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sigfox_api
+
+## 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.
+
+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/[USERNAME]/sigfox_api. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SigfoxApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sigfox_api/blob/master/CODE_OF_CONDUCT.md).

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 "sigfox_api"
+
+# 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/sigfox_api.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'sigfox_api/version'
+require 'sigfox_api/client'
+
+module SigfoxApi
+  # Your code goes here...
+end

data/lib/sigfox_api/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+require_relative 'response'
+require_relative 'device'
+require_relative 'device_type'
+require_relative 'group'
+require_relative 'tile'
+
+module SigfoxApi
+  class Client
+    API_ENDPOINT = 'https://api.sigfox.com'
+
+    include SigfoxApi::Device
+    include SigfoxApi::DeviceType
+    include SigfoxApi::Group
+    include SigfoxApi::Tile
+
+    def initialize(options = {})
+      @login = options[:login]
+      @password = options[:password]
+    end
+
+    private
+
+    def client
+      @client ||= Faraday.new(API_ENDPOINT) do |client|
+        client.request :json
+        client.response :json, content_type: 'application/json', parser_options: { symbolize_names: true }
+        client.adapter Faraday.default_adapter
+        client.basic_auth(@login, @password)
+      end
+    end
+
+    def request(method:, endpoint:, params: {})
+      resp = client.public_send(method, endpoint, params)
+      SigfoxApi::Response.new(resp)
+    end
+  end
+end

data/lib/sigfox_api/device.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SigfoxApi
+  module Device
+    def list_devices(options = {})
+      request(method: :get, endpoint: '/v2/devices', params: options)
+    end
+
+    def disengage_seq_number(device_id)
+      request(method: :post, endpoint: "/v2/devices/#{device_id}/disengage")
+    end
+
+    def suspend_multiple_devices(device_ids = [])
+      params = { data: device_ids }
+      request(method: :post, endpoint: '/v2/devices/bulk/suspend', params: params)
+    end
+  end
+end

data/lib/sigfox_api/device_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SigfoxApi
+  module DeviceType
+    def list_device_types
+      request(method: :get, endpoint: '/v2/device-types')
+    end
+
+    def create_device_type(params)
+      request(method: :post, endpoint: '/v2/device-types', params: params)
+    end
+
+    def device_type(id)
+      request(method: :get, endpoint: "/v2/device-types/#{id}")
+    end
+
+    def list_callbacks(id)
+      request(method: :get, endpoint: "/v2/device-types/#{id}/callbacks")
+    end
+
+    def create_callback(id, params)
+      request(method: :post, endpoint: "/v2/device-types/#{id}/callbacks", params: params)
+    end
+  end
+end

data/lib/sigfox_api/group.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SigfoxApi
+  module Group
+    def list_groups(options = {})
+      request(method: :get, endpoint: '/v2/groups', params: options)
+    end
+
+    def create_group(params)
+      request(method: :post, endpoint: '/v2/groups', params: params)
+    end
+
+    def delete_group(group_id)
+      request(method: :delete, endpoint: "/v2/groups/#{group_id}")
+    end
+  end
+end

data/lib/sigfox_api/response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SigfoxApi
+  class Response
+    def initialize(faraday_response)
+      @row_status = faraday_response.status
+      @row_body = faraday_response.body
+    end
+
+    def status
+      @row_status
+    end
+
+    def body
+      @row_body
+    end
+  end
+end

data/lib/sigfox_api/tile.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SigfoxApi
+  module Tile
+    def monarch
+      request(method: :get, endpoint: '/v2/tiles/monarch')
+    end
+
+    def monarch_kmz(params)
+      request(method: :post, endpoint: '/v2/tiles/monarch/kmz', params: params)
+    end
+
+    def monarch_kmz_results(job_id)
+      request(method: :get, endpoint: "/v2/tiles/monarch/kmz/#{job_id}")
+    end
+
+    def public_operator_kmz(group_id)
+      request(method: :post, endpoint: "/v2/tiles/public-operator/#{group_id}/kmz")
+    end
+  end
+end

data/lib/sigfox_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SigfoxApi
+  VERSION = '0.1.1'
+end

data/sigfox_api.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sigfox_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sigfox_api'
+  spec.version       = SigfoxApi::VERSION
+  spec.authors       = ['nightswinger']
+  spec.email         = ['stardustkids83@gmail.com']
+
+  spec.summary       = 'Simple API wrapper for Sigfox APIv2'
+  spec.description   = 'Ruby client for the Sigfox APIv2.'
+  spec.homepage      = 'https://github.com/nightswinger/sigfox-ruby-client'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '0.17.1'
+  spec.add_dependency 'faraday_middleware', '0.13.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: sigfox_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- nightswinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby client for the Sigfox APIv2.
+email:
+- stardustkids83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sigfox_api.rb
+- lib/sigfox_api/client.rb
+- lib/sigfox_api/device.rb
+- lib/sigfox_api/device_type.rb
+- lib/sigfox_api/group.rb
+- lib/sigfox_api/response.rb
+- lib/sigfox_api/tile.rb
+- lib/sigfox_api/version.rb
+- sigfox_api.gemspec
+homepage: https://github.com/nightswinger/sigfox-ruby-client
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Simple API wrapper for Sigfox APIv2
+test_files: []