GithubHelp home page GithubHelp logo

carlocayos / go-cod Goto Github PK

View Code? Open in Web Editor NEW
9.0 2.0 1.0 533 KB

Call of Duty API Go SDK

Home Page: https://github.com/carlocayos/go-cod

License: MIT License

Makefile 3.19% Shell 0.70% Go 96.11%
go cod call-of-duty sdk modern-warfare warzone coldwar activision blackops golang

go-cod's Issues

Cannot import v2 of the module

When trying to import v2 I get the following message:

require github.com/carlocayos/go-cod: version "v2.0.0" invalid: should be v0 or v1, not v2

Update swagger-spec to change `stream` field into type `map[string]SomeStruct`

Problem:

In the Gamer Loot response payload, it returns a "streams" object with repeating objects (i.e. loot_season_1, loot_season_2, etc).

{
  "status": "success",
  "data": {
    "streams": {
      "loot_season_1": {
        "name": "loot_season_1",
        "categoryNameLabel": "Season 1",
        "categoryTitleLabel": "Season 1",
        "tier": 0,
        "streamType": "season",
        "rarity": null,
        "lootType": null,
        "seasonInfoUrlKey": "season-1",
        "itemsObtained": null,
        "premiumTokenOwnedNotRedeemed": false,
        "tierSkipTokensUnredeemed": null,
        "premium": false
      },
      "loot_season_0": {
        "name": "loot_season_0",
        "categoryNameLabel": "Season 0",
        "categoryTitleLabel": "Season 0",
        "tier": 0,
        "streamType": "season",
        "rarity": null,
        "lootType": null,
        "seasonInfoUrlKey": "season-0",
        "itemsObtained": null,
        "premiumTokenOwnedNotRedeemed": false,
        "tierSkipTokensUnredeemed": null,
        "premium": false
      }
    }
  }
}

Find a way using go-swagger to autogenerate and represent the streams field as type map[string]SomeStruct

Sample

type SomeStruct struct {
  Name string
  CategoryNameLabel string
  CategoryTitleLabel string
  ...
}

someStruct := streams["loot_season_1"]
someStruct.CategoryNameLabel

Add facade to protect codes from breaking API changes

Problem:
Activision can introduce breaking changes to the COD API. The SDK, along with all SDK users will then have to update their codes to adhere to the changes.

Solution:
Implement a facade pattern for simplicity and protecting SDK users of any breaking changes (e.g. Activision changing API format). The facade must be simple, allowing users to pass only the necessary values to the request without managing the swagger auto-generated codes.

Example:

Current steps in sending a leader board request.

c := gocod.NewClient(nil)
serviceOperations := c.ServiceClient.Operations

leaderBoardParams := service.LeaderBoardParams{
    Page:     1,
    Platform: "battle",
    Title:    "mw",
    Context:  context.Background(),
}

leaderBoardResponse, err := serviceOperations.LeaderBoard(&leaderBoardParams)

We can simplify it to this code

c := gocod.NewClient(nil)
c.LeaderBoard(context.Background, 1, "battle", "mw") 
   // or create a simple struct containing passed parameter values

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.